diff options
| author | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
| commit | 713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5 (patch) | |
| tree | 99bdc854fa7a540ee5339de5a2a6888bdc7d003e /Doc/library/sys.rst | |
| parent | daa29d01b749daa4843bcac80bd0067a827cfb8a (diff) | |
| download | cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.zip cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.gz cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.bz2 | |
Fix usage of :option: in the docs (#9312).
:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option. These were
changed to ````.
For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo. Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.
Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.
Patch by Eli Bendersky and Éric Araujo.
Diffstat (limited to 'Doc/library/sys.rst')
| -rw-r--r-- | Doc/library/sys.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/sys.rst b/Doc/library/sys.rst index 01dad9c..c7aa214 100644 --- a/Doc/library/sys.rst +++ b/Doc/library/sys.rst @@ -169,7 +169,7 @@ always available. A string giving the site-specific directory prefix where the platform-dependent Python files are installed; by default, this is also ``'/usr/local'``. This can - be set at build time with the :option:`--exec-prefix` argument to the + be set at build time with the ``--exec-prefix`` argument to the :program:`configure` script. Specifically, all configuration files (e.g. the :file:`pyconfig.h` header file) are installed in the directory ``exec_prefix + '/lib/pythonversion/config'``, and shared library modules are installed in @@ -685,7 +685,7 @@ always available. A string giving the site-specific directory prefix where the platform independent Python files are installed; by default, this is the string - ``'/usr/local'``. This can be set at build time with the :option:`--prefix` + ``'/usr/local'``. This can be set at build time with the ``--prefix`` argument to the :program:`configure` script. The main collection of Python library modules is installed in the directory ``prefix + '/lib/pythonversion'`` while the platform independent header files (all except :file:`pyconfig.h`) are @@ -862,7 +862,7 @@ always available. Activate dumping of VM measurements using the Pentium timestamp counter, if *on_flag* is true. Deactivate these dumps if *on_flag* is off. The function is - available only if Python was compiled with :option:`--with-tsc`. To understand + available only if Python was compiled with ``--with-tsc``. To understand the output of this dump, read :file:`Python/ceval.c` in the Python sources. .. impl-detail:: |