Mercurial > hg
comparison doc/hgrc.5.txt @ 9700:26fc6024dd06
doc: use reST note directive
The 'NOTE: bla bla' syntax was for asciidoc and is still present in a
couple of docstrings. The docstrings will be converted to reST format
when minirst knows how to handle it.
author | Martin Geisler <mg@lazybytes.net> |
---|---|
date | Mon, 02 Nov 2009 21:02:56 +0100 |
parents | 7f4a792e50eb |
children | 0f235a427f95 |
comparison
equal
deleted
inserted
replaced
9699:7f4a792e50eb | 9700:26fc6024dd06 |
---|---|
137 creates a new command ``latest`` that shows only the five most recent | 137 creates a new command ``latest`` that shows only the five most recent |
138 changesets. You can define subsequent aliases using earlier ones:: | 138 changesets. You can define subsequent aliases using earlier ones:: |
139 | 139 |
140 stable5 = latest -b stable | 140 stable5 = latest -b stable |
141 | 141 |
142 NOTE: It is possible to create aliases with the same names as existing | 142 .. note:: It is possible to create aliases with the same names as |
143 commands, which will then override the original definitions. This is | 143 existing commands, which will then override the original |
144 almost always a bad idea! | 144 definitions. This is almost always a bad idea! |
145 | 145 |
146 | 146 |
147 ``auth`` | 147 ``auth`` |
148 """""""" | 148 """""""" |
149 Authentication credentials for HTTP authentication. Each line has | 149 Authentication credentials for HTTP authentication. Each line has |
230 with the name of a temporary file that contains the data to be | 230 with the name of a temporary file that contains the data to be |
231 filtered by the command. The string OUTFILE is replaced with the name | 231 filtered by the command. The string OUTFILE is replaced with the name |
232 of an empty temporary file, where the filtered data must be written by | 232 of an empty temporary file, where the filtered data must be written by |
233 the command. | 233 the command. |
234 | 234 |
235 NOTE: the tempfile mechanism is recommended for Windows systems, where | 235 .. note:: The tempfile mechanism is recommended for Windows systems, |
236 the standard shell I/O redirection operators often have strange | 236 where the standard shell I/O redirection operators often have |
237 effects and may corrupt the contents of your files. | 237 strange effects and may corrupt the contents of your files. |
238 | 238 |
239 The most common usage is for LF <-> CRLF translation on Windows. For | 239 The most common usage is for LF <-> CRLF translation on Windows. For |
240 this, use the "smart" converters which check for binary files:: | 240 this, use the "smart" converters which check for binary files:: |
241 | 241 |
242 [extensions] | 242 [extensions] |
573 Run after updating the working directory. Changeset ID of first | 573 Run after updating the working directory. Changeset ID of first |
574 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is | 574 new parent is in ``$HG_PARENT1``. If merge, ID of second new parent is |
575 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the | 575 in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the |
576 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``. | 576 update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``. |
577 | 577 |
578 NOTE: it is generally better to use standard hooks rather than the | 578 .. note:: It is generally better to use standard hooks rather than the |
579 generic pre- and post- command hooks as they are guaranteed to be | 579 generic pre- and post- command hooks as they are guaranteed to be |
580 called in the appropriate contexts for influencing transactions. | 580 called in the appropriate contexts for influencing transactions. |
581 Also, hooks like "commit" will be called in all contexts that | 581 Also, hooks like "commit" will be called in all contexts that |
582 generate a commit (e.g. tag) and not just the commit command. | 582 generate a commit (e.g. tag) and not just the commit command. |
583 | 583 |
584 NOTE: Environment variables with empty values may not be passed to | 584 .. note:: Environment variables with empty values may not be passed to |
585 hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` will | 585 hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` |
586 have an empty value under Unix-like platforms for non-merge | 586 will have an empty value under Unix-like platforms for non-merge |
587 changesets, while it will not be available at all under Windows. | 587 changesets, while it will not be available at all under Windows. |
588 | 588 |
589 The syntax for Python hooks is as follows:: | 589 The syntax for Python hooks is as follows:: |
590 | 590 |
591 hookname = python:modulename.submodule.callable | 591 hookname = python:modulename.submodule.callable |
592 hookname = python:/path/to/python/module.py:callable | 592 hookname = python:/path/to/python/module.py:callable |