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.
--- a/doc/hgrc.5.txt Mon Nov 02 20:53:34 2009 +0100
+++ b/doc/hgrc.5.txt Mon Nov 02 21:02:56 2009 +0100
@@ -139,9 +139,9 @@
stable5 = latest -b stable
-NOTE: It is possible to create aliases with the same names as existing
-commands, which will then override the original definitions. This is
-almost always a bad idea!
+.. note:: It is possible to create aliases with the same names as
+ existing commands, which will then override the original
+ definitions. This is almost always a bad idea!
``auth``
@@ -232,9 +232,9 @@
of an empty temporary file, where the filtered data must be written by
the command.
-NOTE: the tempfile mechanism is recommended for Windows systems, where
-the standard shell I/O redirection operators often have strange
-effects and may corrupt the contents of your files.
+.. note:: The tempfile mechanism is recommended for Windows systems,
+ where the standard shell I/O redirection operators often have
+ strange effects and may corrupt the contents of your files.
The most common usage is for LF <-> CRLF translation on Windows. For
this, use the "smart" converters which check for binary files::
@@ -575,16 +575,16 @@
in ``$HG_PARENT2``. If the update succeeded, ``$HG_ERROR=0``. If the
update failed (e.g. because conflicts not resolved), ``$HG_ERROR=1``.
-NOTE: it is generally better to use standard hooks rather than the
-generic pre- and post- command hooks as they are guaranteed to be
-called in the appropriate contexts for influencing transactions.
-Also, hooks like "commit" will be called in all contexts that
-generate a commit (e.g. tag) and not just the commit command.
+.. note:: It is generally better to use standard hooks rather than the
+ generic pre- and post- command hooks as they are guaranteed to be
+ called in the appropriate contexts for influencing transactions.
+ Also, hooks like "commit" will be called in all contexts that
+ generate a commit (e.g. tag) and not just the commit command.
-NOTE: Environment variables with empty values may not be passed to
-hooks on platforms such as Windows. As an example, ``$HG_PARENT2`` will
-have an empty value under Unix-like platforms for non-merge
-changesets, while it will not be available at all under Windows.
+.. note:: Environment variables with empty values may not be passed to
+ hooks on platforms such as Windows. As an example, ``$HG_PARENT2``
+ will have an empty value under Unix-like platforms for non-merge
+ changesets, while it will not be available at all under Windows.
The syntax for Python hooks is as follows::