Add warning formatting

Any paragraph starting with IMPORTANT NOTE: is transformed into a warning.
This commit is contained in:
Richard Berger
2017-01-03 02:34:11 +01:00
parent 7d057d4c83
commit 4f45d39ac7

View File

@ -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/tutorial_github.txt
$ git add doc/src/JPG/tutorial_*.png :pre $ git add doc/src/JPG/tutorial_*.png :pre
[Warning] 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.
{Do not use `git commit -a`. The -a flag will automatically include It can easily create to accidentally adding unrelated and unwanted changes into
_all_ modified or new files and that is rarely the behavior you want. the repository. It is highly preferable to explicitly use `git add`, `git rm`,
It can easily create to accidentally adding unrelated and unwanted `git mv` for adding, removing, renaming files, respectively, and then `git
changes into the repository. It is highly preferable to explicitly commit` to finalize the commit. If you find doing this on the command line too
use `git add`, `git rm`, `git mv` for adding, removing, renaming files, tedious, consider using a GUI, the one included in git distributions written in
respectively, and then `git commit` to finalize the commit. If you Tk, i.e. use `git gui`.
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 After adding all files, the change can be commited with some useful message
that explains the change. that explains the change.