From 4f45d39ac72b69d5e8eaf43165c07c03f761c06a Mon Sep 17 00:00:00 2001 From: Richard Berger <richard.berger@temple.edu> Date: Tue, 3 Jan 2017 02:34:11 +0100 Subject: [PATCH] Add warning formatting Any paragraph starting with IMPORTANT NOTE: is transformed into a warning. --- doc/src/tutorial_github.txt | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/doc/src/tutorial_github.txt b/doc/src/tutorial_github.txt index b0c83c603e..c7711c70c2 100644 --- a/doc/src/tutorial_github.txt +++ b/doc/src/tutorial_github.txt @@ -111,16 +111,14 @@ After everything is done, add the files to the branch and commit them: $ git add doc/src/tutorial_github.txt $ git add doc/src/JPG/tutorial_*.png :pre -[Warning] - -{Do not use `git commit -a`. The -a flag will automatically include -_all_ modified or new files and that is rarely the behavior you want. -It can easily create to accidentally adding unrelated and unwanted -changes into the repository. It is highly preferable to explicitly -use `git add`, `git rm`, `git mv` for adding, removing, renaming files, -respectively, and then `git commit` to finalize the commit. If you -find doing this on the command line too tedious, consider using a GUI, -the one included in git distributions written in Tk, i.e. use `git gui`.} +IMPORTANT NOTE: Do not use `git commit -a`. The -a flag will automatically +include _all_ modified or new files and that is rarely the behavior you want. +It can easily create to accidentally adding unrelated and unwanted changes into +the repository. It is highly preferable to explicitly use `git add`, `git rm`, +`git mv` for adding, removing, renaming files, respectively, and then `git +commit` to finalize the commit. If you find doing this on the command line too +tedious, consider using a GUI, the one included in git distributions written in +Tk, i.e. use `git gui`. After adding all files, the change can be commited with some useful message that explains the change. -- GitLab