Reviewers: ,

Message:
Please review.  Having separate subsections for Commits and Patches will
make it easier to quickly navigate to one or the other from the table of
contents.  And since they are in fact two different things, separate
subsections makes conceptual sense, perhaps especially for those
learning git.

Thanks,
-Paul

Description:
Doc: CG 3.3 separate commits and patches subsections

Please review this at https://codereview.appspot.com/285480043/

Affected files (+18, -9 lines):
  M Documentation/contributor/administration.itexi
  M Documentation/contributor/issues.itexi
  M Documentation/contributor/quick-start.itexi
  M Documentation/contributor/source-code.itexi


Index: Documentation/contributor/administration.itexi
diff --git a/Documentation/contributor/administration.itexi b/Documentation/contributor/administration.itexi index a392f7d660f8e62cf5518c6678acba472ffa3b58..510a799d9170a18b0b09693cf6c354e677ff32f4 100644
--- a/Documentation/contributor/administration.itexi
+++ b/Documentation/contributor/administration.itexi
@@ -167,7 +167,7 @@ The Patch Meister's responsibilities are:
 To keep track of all patches submitted for testing and review.  This
 includes scanning the bug and dev email lists looking for any patches
 submitted by @q{random} contributors and advising them on how to submit
-a patch for testing and review.  See @ref{Commits and patches}.
+a patch for testing and review.  See @ref{Patches}.

 @item
 To makes sure that any patch submitted has a corresponding Issue Tracker
Index: Documentation/contributor/issues.itexi
diff --git a/Documentation/contributor/issues.itexi b/Documentation/contributor/issues.itexi index 883328f85a2345a76760986b8e45fff1def3eda8..09925d4208c80e084f080aad5aa1c42226e7bdb0 100644
--- a/Documentation/contributor/issues.itexi
+++ b/Documentation/contributor/issues.itexi
@@ -825,7 +825,7 @@ email should contain a link to the issue you just added.
 separate person handling this task.}

 For contributors/developers: follow the steps in
-@ref{Commits and patches}, and @ref{Pushing to staging}.
+@ref{Commits}, @ref{Patches}, and @ref{Pushing to staging}.

 @ignore
 For people doing maintenance tasks: git-cl is adding issues, James
Index: Documentation/contributor/quick-start.itexi
diff --git a/Documentation/contributor/quick-start.itexi b/Documentation/contributor/quick-start.itexi index 9a5b12a7ec36d597e6eef5875588c2d65ec6c4d5..b5ccb3b0b8212abee2f492de84d895003b9cd042 100644
--- a/Documentation/contributor/quick-start.itexi
+++ b/Documentation/contributor/quick-start.itexi
@@ -362,7 +362,7 @@ After entering a commit message, click @qq{OK} to finalize the
 commit.

 @advanced{for more information regarding commits and commit
-messages, see @ref{Commits and patches}.}
+messages, see @ref{Commits}.}


 @subsubheading 2b. Amend previous commit
Index: Documentation/contributor/source-code.itexi
diff --git a/Documentation/contributor/source-code.itexi b/Documentation/contributor/source-code.itexi index 719c85e041ba80021059c338d3c0b1047f76cc13..7c4dc63778584703f17823f636e9f928483aef82 100644
--- a/Documentation/contributor/source-code.itexi
+++ b/Documentation/contributor/source-code.itexi
@@ -848,7 +848,8 @@ The branches are kept for archival reasons.
 * The Git contributor's cycle::
 * Pulling and rebasing::
 * Using local branches::
-* Commits and patches::
+* Commits::
+* Patches::
 @end menu


@@ -940,7 +941,7 @@ refusing to pull with rebase: your working tree is not up-to-date

 @noindent
 it means that you have modified some files in you working tree
-without committing changes (see @ref{Commits and patches}); you
+without committing changes (see @ref{Commits}); you
 can use the @command{git@tie{}stash} command to work around this:

 @example
@@ -1088,16 +1089,14 @@ to merge @code{translation} into @code{staging} whenever he has
 checked that @code{translation} builds successfully.


-@node Commits and patches
-@subsection Commits and patches
+@node Commits
+@subsection Commits


 @menu
 * Understanding commits::
 * Making commits::
 * Commit messages::
-* Making patches::
-* Uploading a patch for review::
 @end menu


@@ -1248,6 +1247,16 @@ involved. Visit the links listed in @ref{Understanding commits}
 for examples.


+@node Patches
+@subsection Patches
+
+
+@menu
+* Making patches::
+* Uploading a patch for review::
+@end menu
+
+
 @node Making patches
 @unnumberedsubsubsec Making patches




_______________________________________________
lilypond-devel mailing list
lilypond-devel@gnu.org
https://lists.gnu.org/mailman/listinfo/lilypond-devel

Reply via email to