{"thread":{"id":"36193","subject":"[PATCH pu] Documentation/giteveryday: fix some obvious problems","startedAt":"2014-03-16T23:11:46Z","lastAt":"2014-03-16T23:11:46Z","messageCount":1,"participants":["Ramkumar Ramachandra"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"236847","messageId":"1395011506-21447-1-git-send-email-artagnon@gmail.com","threadId":"36193","inReplyTo":null,"subject":"[PATCH pu] Documentation/giteveryday: fix some obvious problems","fromName":"Ramkumar Ramachandra","fromEmail":"artagnon@gmail.com","sentAt":"2014-03-16T23:11:46Z","receivedAt":"2014-03-16T23:11:46Z","isPatch":true,"sender":{"key":"r@artagnon.com","avatar":"https://avatars.githubusercontent.com/u/37226?v=4"},"body":"Fix a few minor things.\n\nSigned-off-by: Ramkumar Ramachandra <artagnon@gmail.com>\n---\n Philip,\n\n I spotted a few obvious issues with your giteveryday patch in\n pu. Maybe Junio can squash this into your patch? Contents are still a\n bit stale, but I'm not sure what other markup problems are there.\n\n Documentation/giteveryday.txt | 78 +++++++++++++++++++++----------------------\n 1 file changed, 38 insertions(+), 40 deletions(-)\n\ndiff --git a/Documentation/giteveryday.txt b/Documentation/giteveryday.txt\nindex 8dc298f..82ff8ec 100644\n--- a/Documentation/giteveryday.txt\n+++ b/Documentation/giteveryday.txt\n@@ -35,8 +35,6 @@ following commands.\n \n   * linkgit:git-init[1] to create a new repository.\n \n-  * linkgit:git-show-branch[1] to see where you are.\n-\n   * linkgit:git-log[1] to see what happened.\n \n   * linkgit:git-checkout[1] and linkgit:git-branch[1] to switch\n@@ -61,8 +59,8 @@ following commands.\n Examples\n ~~~~~~~~\n \n-Use a tarball as a starting point for a new repository.::\n-+\n+Use a tarball as a starting point for a new repository:\n+\n ------------\n $ tar zxf frotz.tar.gz\n $ cd frotz\n@@ -71,12 +69,12 @@ $ git add . <1>\n $ git commit -m \"import of frotz source tree.\"\n $ git tag v2.43 <2>\n ------------\n-+\n+\n <1> add everything under the current directory.\n <2> make a lightweight, unannotated tag.\n \n-Create a topic branch and develop.::\n-+\n+Create a topic branch and develop:\n+\n ------------\n $ git checkout -b alsa-audio <1>\n $ edit/compile/test\n@@ -95,7 +93,7 @@ $ git merge alsa-audio <10>\n $ git log --since='3 days ago' <11>\n $ git log v2.43.. curses/ <12>\n ------------\n-+\n+\n <1> create a new topic branch.\n <2> revert your botched changes in `curses/ux_audio_oss.c`.\n <3> you need to tell Git if you added a new file; removal and\n@@ -137,8 +135,8 @@ addition to the ones needed by a standalone developer.\n Examples\n ~~~~~~~~\n \n-Clone the upstream and work on it.  Feed changes to upstream.::\n-+\n+Clone the upstream and work on it.  Feed changes to upstream:\n+\n ------------\n $ git clone git://git.kernel.org/pub/scm/.../torvalds/linux-2.6 my2.6\n $ cd my2.6\n@@ -151,7 +149,7 @@ $ git reset --hard ORIG_HEAD <6>\n $ git gc <7>\n $ git fetch --tags <8>\n ------------\n-+\n+\n <1> repeat as needed.\n <2> extract patches from your branch for e-mail submission.\n <3> `git pull` fetches from `origin` by default and merges into the\n@@ -166,8 +164,8 @@ area we are interested in.\n and store them under `.git/refs/tags/`.\n \n \n-Push into another repository.::\n-+\n+Push into another repository:\n+\n ------------\n satellite$ git clone mothership:frotz frotz <1>\n satellite$ cd frotz\n@@ -185,7 +183,7 @@ mothership$ cd frotz\n mothership$ git checkout master\n mothership$ git merge satellite/master <5>\n ------------\n-+\n+\n <1> mothership machine has a frotz repository under your home\n directory; clone from it to start a repository on the satellite\n machine.\n@@ -200,8 +198,8 @@ as a back-up method.\n <5> on mothership machine, merge the work done on the satellite\n machine into the master branch.\n \n-Branch off of a specific tag.::\n-+\n+Branch off of a specific tag:\n+\n ------------\n $ git checkout -b private2.6.14 v2.6.14 <1>\n $ edit/compile/test; git commit -a\n@@ -209,7 +207,7 @@ $ git checkout master\n $ git format-patch -k -m --stdout v2.6.14..private2.6.14 |\n   git am -3 -k <2>\n ------------\n-+\n+\n <1> create a private branch based on a well known (but somewhat behind)\n tag.\n <2> forward port all changes in `private2.6.14` branch to `master` branch\n@@ -240,8 +238,8 @@ commands in addition to the ones needed by participants.\n Examples\n ~~~~~~~~\n \n-My typical Git day.::\n-+\n+My typical Git day:\n+\n ------------\n $ git status <1>\n $ git show-branch <2>\n@@ -261,10 +259,10 @@ $ git cherry-pick master~4 <9>\n $ compile/test\n $ git tag -s -m \"GIT 0.99.9x\" v0.99.9x <10>\n $ git fetch ko && git show-branch master maint 'tags/ko-*' <11>\n-$ git push ko <12>\n-$ git push ko v0.99.9x <13>\n+$ git push ko\n+$ git push ko v0.99.9x\n ------------\n-+\n+\n <1> see what I was in the middle of doing, if any.\n <2> see what topic branches I have and think about how ready\n they are.\n@@ -282,7 +280,7 @@ master, nor exposed as a part of a stable branch.\n <11> make sure I did not accidentally rewind master beyond what I\n already pushed out.  `ko` shorthand points at the repository I have\n at kernel.org, and looks like this:\n-+\n+\n ------------\n $ cat .git/remotes/ko\n URL: kernel.org:/pub/scm/git/git.git\n@@ -294,7 +292,7 @@ Push: next\n Push: +pu\n Push: maint\n ------------\n-+\n+\n In the output from `git show-branch`, `master` should have\n everything `ko-master` has, and `next` should have\n everything `ko-next` has.\n@@ -322,24 +320,24 @@ example of managing a shared central repository.\n Examples\n ~~~~~~~~\n We assume the following in /etc/services::\n-+\n+\n ------------\n $ grep 9418 /etc/services\n git\t\t9418/tcp\t\t# Git Version Control System\n ------------\n \n-Run git-daemon to serve /pub/scm from inetd.::\n-+\n+Run git-daemon to serve /pub/scm from inetd:\n+\n ------------\n $ grep git /etc/inetd.conf\n git\tstream\ttcp\tnowait\tnobody \\\n   /usr/bin/git-daemon git-daemon --inetd --export-all /pub/scm\n ------------\n-+\n+\n The actual configuration line should be on one line.\n \n-Run git-daemon to serve /pub/scm from xinetd.::\n-+\n+Run git-daemon to serve /pub/scm from xinetd:\n+\n ------------\n $ cat /etc/xinetd.d/git-daemon\n # default: off\n@@ -357,12 +355,12 @@ service git\n         log_on_failure  += USERID\n }\n ------------\n-+\n+\n Check your xinetd(8) documentation and setup, this is from a Fedora system.\n Others might be different.\n \n-Give push/pull only access to developers.::\n-+\n+Give push/pull only access to developers:\n+\n ------------\n $ grep git /etc/passwd <1>\n alice:x:1000:1000::/home/alice:/usr/bin/git-shell\n@@ -372,15 +370,15 @@ david:x:1003:1003::/home/david:/usr/bin/git-shell\n $ grep git /etc/shells <2>\n /usr/bin/git-shell\n ------------\n-+\n+\n <1> log-in shell is set to /usr/bin/git-shell, which does not\n allow anything but `git push` and `git pull`.  The users should\n get an ssh access to the machine.\n <2> in many distributions /etc/shells needs to list what is used\n as the login shell.\n \n-CVS-style shared repository.::\n-+\n+CVS-style shared repository:\n+\n ------------\n $ grep git /etc/group <1>\n git:x:9418:alice,bob,cindy,david\n@@ -403,7 +401,7 @@ refs/heads/master\talice\\|cindy\n refs/heads/doc-update\tbob\n refs/tags/v[0-9]*\tdavid\n ------------\n-+\n+\n <1> place the developers into the same git group.\n <2> and make the shared repository writable by the group.\n <3> use update-hook example by Carl from Documentation/howto/\n@@ -412,14 +410,14 @@ for branch policy control.\n david is the release manager and is the only person who can\n create and push version tags.\n \n-HTTP server to support dumb protocol transfer.::\n-+\n+HTTP server to support dumb protocol transfer:\n+\n ------------\n dev$ git update-server-info <1>\n dev$ ftp user@isp.example.com <2>\n ftp> cp -r .git /home/user/myproject.git\n ------------\n-+\n+\n <1> make sure your info/refs and objects/info/packs are up-to-date\n <2> upload to public HTTP server hosted by your ISP.\n \n-- \n1.9.0.431.g014438b\n"}]}