~jan0sch/darcs-book

Showing details for patch 56921ca626286ee5768652549ab1c78747255c00.
2018-07-01 (Sun), 11:43 AM - - 56921ca626286ee5768652549ab1c78747255c00

add a bit more clarity to chapter 1

Summary of changes
1 files modified with 31 lines added and 10 lines removed
  • en/01-introduction.md with 31 added and 10 removed lines
diff -rN -u old-darcs-book/en/01-introduction.md new-darcs-book/en/01-introduction.md
--- old-darcs-book/en/01-introduction.md	2024-11-24 01:22:54.482968530 +0000
+++ new-darcs-book/en/01-introduction.md	2024-11-24 01:22:54.482968530 +0000
@@ -14,6 +14,15 @@
 In this book I will assume that you are using a Unix or Unix-like
 operating system.
 
+Most of the examples in this book happen inside of a shell and the issued
+commands prefixed with a `$` symbol while its output isn't prefixed with
+anything. Here's an example command that only outputs the word `output`.
+
+```
+$ echo output
+output
+```
+
 What's version control?
 -----------------------
 
@@ -87,11 +96,22 @@
 `git` to illustrate this. If you don't fully understand what's happening here,
 that's fine. It's not necessary to use `darcs` efficiently.
 
-gimbar pulls in jeanny's and then tauli's patches. gimbar now has the following
-patches in their repository.
+In the beginning gimbar and I both are on the same snapshot which I have
+suggestively called "previous work". Both our repositories look like this.
 
 ```
-commit fd9d393916a76bf716d4af6485556182aaaab5a2 (HEAD -> master)
+commit 85b41da2f0a273c6691ee56b13dfe3590d4d0418
+Author: raichoo
+Date:   Tue Jun 26 18:58:52 2018 +0200
+
+    previous work
+```
+
+gimbar then pulls in jeanny's and then tauli's patches. gimbar now has the
+following patches in their repository.
+
+```
+commit fd9d393916a76bf716d4af6485556182aaaab5a2
 Merge: c083eb1 425b39d
 Author: gimbar
 Date:   Tue Jun 26 19:00:37 2018 +0200
@@ -110,7 +130,7 @@
 
     graphics
 
-commit 85b41da2f0a273c6691ee56b13dfe3590d4d0418 (origin/master, origin/HEAD)
+commit 85b41da2f0a273c6691ee56b13dfe3590d4d0418
 Author: raichoo
 Date:   Tue Jun 26 18:58:52 2018 +0200
 
@@ -123,7 +143,7 @@
 jeanny's. I now have the following patches applied to my repository.
 
 ```
-commit 48f2fa962e67f7bbb12d1f4d6d3b823e1905b16c (HEAD -> master)
+commit 48f2fa962e67f7bbb12d1f4d6d3b823e1905b16c
 Merge: 425b39d c083eb1
 Author: raichoo
 Date:   Tue Jun 26 19:00:14 2018 +0200
@@ -143,17 +163,18 @@
     some code
 
 commit 85b41da2f0a273c6691ee56b13dfe3590d4d0418
-Author: raichoo <raichoo@googlemail.com>
+Author: raichoo
 Date:   Tue Jun 26 18:58:52 2018 +0200
 
     previous work
 
 ```
 
-Now `git` created those *Merge* patches for us, but they are quite different for
-gimbar's and me. They have a different author, a different timestamp etc. Now we
-have to coordinate how we proceed because we are not working on the same
-snapshot anymore.
+`git` created those *Merge* patches for us, but they are quite different for
+gimbar and me. They have a different author, a different timestamp and most
+importantly, they have a different hash which is an alpha numeric identifier
+that uniquely identifies a snapshot. Now we have to coordinate how we proceed
+because we are not working on the same snapshot anymore.
 
 In the snapshot based approach we end up with both of our repositories in
 different states even though both of us pulled in the same patches, we just have