Ticket #12613: 12613_review_doc.patch

File 12613_review_doc.patch, 2.0 KB (added by jdemeyer, 9 years ago)
  • doc/en/reference/options.rst

    # HG changeset patch
    # User Jeroen Demeyer <jdemeyer@cage.ugent.be>
    # Date 1333790684 -7200
    # Node ID 005fd2d329abf7573ccc29dd9c93fce9b42f5b50
    # Parent  f6ad33755d7a8afa47e4d9100fa9488de5f1d6ee
    Don't duplicate documentation for -i and -f options
    
    diff --git a/doc/en/reference/options.rst b/doc/en/reference/options.rst
    a b  
    7979
    8080.. rubric:: Installing packages and upgrading
    8181
    82 - ``-i [packages]`` -- install the given Sage packages.  If no
    83   packages are given, print a list of all installed packages.
    84 - ``-i -s [packages]`` -- like ``-i`` but do not delete the
    85   spkg/build directories -- useful for debugging.
    86 - ``-i -c [packages]`` -- like ``-i`` but also run the packages' test
    87   suites, overriding the settings of :envvar:`SAGE_CHECK` and
    88   :envvar:`SAGE_CHECK_PACKAGES`.
    89 - ``-f [packages]`` -- force build of the given Sage package (even if
    90   it is already installed)
    91 - ``-f -s [packages]`` -- like -f but do not delete the spkg/build
    92   directories
    93 - ``-f -c [packages]`` -- like ``-i`` but also run the packages' test
    94   suites, overriding the settings of :envvar:`SAGE_CHECK` and
    95   :envvar:`SAGE_CHECK_PACKAGES`.
     82- ``-i [options] [packages]`` -- install the given Sage packages (unless
     83  they are already installed); if no packages are given, print
     84  a list of all installed packages. Options:
     85
     86  - ``-c`` -- run the packages' test suites, overriding the settings of
     87    :envvar:`SAGE_CHECK` and :envvar:`SAGE_CHECK_PACKAGES`.
     88  - ``-f`` -- force build: install the packages even if they are
     89    already installed.
     90  - ``-s`` -- do not delete the ``spkg/build`` directories after a
     91    successful build -- useful for debugging.
     92
     93- ``-f [options] [packages]`` -- shortcut for ``-i -f``: force build of
     94  the given Sage packages.
    9695- ``--standard`` -- list all standard packages that can be installed
    9796- ``--optional`` -- list all optional packages that can be installed
    9897- ``--experimental`` -- list all experimental packages that can be installed