Răsfoiți Sursa

fix docutils syntax and a few typos

Hervé Cauwelier 15 ani în urmă
părinte
comite
4cf7c97069
2 a modificat fișierele cu 14 adăugiri și 14 ștergeri
  1. 4 4
      docs/tutorial/0-introduction.txt
  2. 10 10
      docs/tutorial/1-initial-commit.txt

+ 4 - 4
docs/tutorial/0-introduction.txt

@@ -31,7 +31,7 @@ The Commit
 ----------
 ----------
 
 
 You're used to generate commits using Git. You have set up your name and
 You're used to generate commits using Git. You have set up your name and
-e-mail, and you know how to see the history using "git log".
+e-mail, and you know how to see the history using ``git log``.
 
 
 A commit file looks like this::
 A commit file looks like this::
 
 
@@ -56,11 +56,11 @@ A tree file looks like this::
 
 
   tree <content length><NUL><file mode> <filename><NUL><blob sha>...
   tree <content length><NUL><file mode> <filename><NUL><blob sha>...
 
 
-And repeats for every file in the tree. A real example from Dulwich itself::
+And repeats for every file in the tree.
 
 
 Note that for a unknown reason, the SHA-1 digest is in binary form here.
 Note that for a unknown reason, the SHA-1 digest is in binary form here.
 
 
-The file mode is like the octal argument you could give to the "chmod"
+The file mode is like the octal argument you could give to the ``chmod``
 command.  Except it is in extended form to tell regular files from
 command.  Except it is in extended form to tell regular files from
 directories and other types.
 directories and other types.
 
 
@@ -99,7 +99,7 @@ For instance there is an index of the current state of the working copy.
 There are also pack files to group several small objects in a single indexed
 There are also pack files to group several small objects in a single indexed
 file.
 file.
 
 
-You'll find more detailled explanations and examples here:
+For a more detailled explanation of object formats and SHA-1 digests, see:
 http://www-cs-students.stanford.edu/~blynn/gitmagic/ch08.html
 http://www-cs-students.stanford.edu/~blynn/gitmagic/ch08.html
 
 
 Just note that recent versions of Git compress object files using zlib.
 Just note that recent versions of Git compress object files using zlib.

+ 10 - 10
docs/tutorial/1-initial-commit → docs/tutorial/1-initial-commit.txt

@@ -13,14 +13,14 @@ The access to every object is through the Repo object. You can open an
 existing repository or you can create a new one. There are two types of Git
 existing repository or you can create a new one. There are two types of Git
 repositories:
 repositories:
 
 
-  Regular Repositories -- They are the ones you create using "git init" and
-  you daily use. They contain a ".git" folder.
+  Regular Repositories -- They are the ones you create using ``git init`` and
+  you daily use. They contain a ``.git`` folder.
 
 
   Bare Repositories -- There is not ".git" folder. The top-level folder
   Bare Repositories -- There is not ".git" folder. The top-level folder
   contains itself the "branches", "hooks"... folders. These are used for
   contains itself the "branches", "hooks"... folders. These are used for
   published repositories (mirrors).
   published repositories (mirrors).
 
 
-Let's create a folder and turn it into a repository, like "git init" would::
+Let's create a folder and turn it into a repository, like ``git init`` would::
 
 
   >>> from os import mkdir
   >>> from os import mkdir
   >>> mkdir("myrepo")
   >>> mkdir("myrepo")
@@ -42,7 +42,7 @@ empty for now, we'll start by adding a new file::
   >>> blob.id
   >>> blob.id
   '456a1e689eb87b947be24562e830421cd799388c'
   '456a1e689eb87b947be24562e830421cd799388c'
 
 
-Of course you could create a blob from an existing file using "from_file"
+Of course you could create a blob from an existing file using ``from_file``
 instead.
 instead.
 
 
 As said in the introduction, file content is separed from file name. Let's
 As said in the introduction, file content is separed from file name. Let's
@@ -100,7 +100,7 @@ Playing again with Git
 ======================
 ======================
 
 
 At this point you can come back to the shell, go into the "myrepo" folder and
 At this point you can come back to the shell, go into the "myrepo" folder and
-type "git status" to let Git confirm that this is a regular repository on
+type ``git status`` to let Git confirm that this is a regular repository on
 branch "master".
 branch "master".
 
 
 Git will tell you that the file "spam" is deleted, which is normal because
 Git will tell you that the file "spam" is deleted, which is normal because
@@ -110,13 +110,13 @@ all!
 
 
 You can checkout the last state using ``git checkout -f``. The force flag
 You can checkout the last state using ``git checkout -f``. The force flag
 will prevent Git from complaining that there are uncommitted changes in the
 will prevent Git from complaining that there are uncommitted changes in the
-checkout.
+working copy.
 
 
-The file ``spam`` appears and with no surprise::
+The file ``spam`` appears and with no surprise contains the same bytes as the
+blob::
 
 
   $ cat spam
   $ cat spam
   My file content
   My file content
 
 
-contains the same bytes as the blob.
-
-Remember to reload the repository when you modify it outside of Dulwich!
+.. attention:: Remember to recreate the repo object when you modify the
+               repository outside of Dulwich!