Skip to content
Snippets Groups Projects
  1. Jun 23, 2014
  2. Mar 11, 2014
    • Katsunori FUJIWARA's avatar
      doc: show short description of each commands in generated documents · 401f9b66
      Katsunori FUJIWARA authored
      Before this patch, short description of each commands is not shown in
      generated documents (HTML file and UNIX man page). This omitting may
      prevent users from understanding about commands.
      
      This patch show it as the 1st paragraph in the help section of each
      commands. This style is chosen because:
      
        - showing it as the section title in "command - short desc" style
          disallows referencing by "#command" in HTML file: in "en" locale,
          hyphen concatenated title is used as the section ID in HTML file
          for this style
      
        - showing it as the 1st paragraph in "command - short desc" style
          seems to be redundant: "command" appears also just before as the
          section title
      
        - showing it just after synopsis like "hg help command" seems not to
          be reasonable in UNIX man page
      
      This patch just writes short description ("d['desc'][0]") before "::",
      because it should be already "strip()"-ed in "get_desc()", or empty
      string for the command without description.
      401f9b66
  3. Feb 20, 2014
    • Simon Heimberg's avatar
      doc: gendoc.py creates valid output for option descriptions with newlines · 37f3be9d
      Simon Heimberg authored
      gendoc.py did not handle the hanging indentation for descriptions. Work around
      this by joining all in one single line (same as in minirst since previous
      patch).
      
      This problem occurred when translations of option lines were very long. Do not
      bother the translators with this detail.
      
      On a long option description, the translator continued on a new line as usual.
      gendoc.py created invalid rst syntax like this:
      
      -o, --option
          Description line 1
      description line 2
      
      The new output is:
      
      -o, --option
          Description line 1 description line 2
      
      The lines could theoretically become very long, but line breaking is handled
      when generating the final documentation.
      37f3be9d
  4. Nov 08, 2013
    • Katsunori FUJIWARA's avatar
      doc: show details of command options in pages generated by docutils · 93f9d116
      Katsunori FUJIWARA authored
      Before this patch, HTML/man pages generated by docutils don't show
      details of each command options, whether it should take argument or
      not for example, even though "hg help" does.
      
      This patch shows details of command options as same as "hg help"
      shows.
      
      This patch uses "--option <VALUE[+]>" style instead of "--option
      <VALUE> [+]" used in output of "hg help", because docutils requires
      that option argument strings starts with "<" and ends with ">".
      93f9d116
  5. Jul 19, 2013
  6. Jul 03, 2013
  7. Jul 01, 2013
  8. Jun 12, 2013
  9. Jun 20, 2013
  10. May 15, 2013
  11. Apr 17, 2013
  12. Apr 14, 2013
  13. Feb 10, 2013
  14. Dec 09, 2012
  15. Aug 13, 2012
    • Katsunori FUJIWARA's avatar
      doc: add the tool to check section marks in help documents · 07f1ac17
      Katsunori FUJIWARA authored
      This patch adds "doc/check-seclevel.py" which checks below in help
      documents:
      
        - whether unknown or unavailable section marks are used or not
        - whether appropriate section mark is used at sub-sectioning
      
      It should be invoked in "doc" directory.
      
      It checks all help documents of Mercurial (topics, commands,
      extensions), if no file is specified by --file option.
      
      With --file option, it checks contents of the specified file as help
      document, for self testing purpose: -t/-c/-e/-C are used to specify
      what kind of help document contents of the specified file is.
      
      This checking is related to changeset 979b107eaea2.
      07f1ac17
  16. Aug 17, 2012
  17. Jul 25, 2012
    • Katsunori FUJIWARA's avatar
      doc: unify section level between help topics · 979b107e
      Katsunori FUJIWARA authored
      Some help topics use "-" for the top level underlining section mark,
      but "-" is used also for the top level categorization in generated
      documents: "hg.1.html", for example.
      
      So, TOC in such documents contain "sections in each topics", too.
      
      This patch changes underlining section mark in some help topics to
      unify section level in generated documents.
      
      After this patching, levels of each section marks are:
      
        level0
        """"""
          level1
          ======
            level2
            ------
              level3
              ......
                level4
                ######
      
      And use of section markers in each documents are:
      
        - mercurial/help/*.txt can use level1 or more
          (now these use level1 and level2)
      
        - help for core commands can use level2 or more
          (now these use no section marker)
      
        - descriptions of extensions can use level2 or more
          (now hgext/acl uses level2)
      
        - help for commands defined in extension can use level4 or more
          (now "convert" of hgext/convert uses level4)
      
      "Level0" is used as top level categorization only in "doc/hg.1.txt"
      and the intermediate file generated by "doc/gendoc.py", so end users
      don't see it in "hg help" outoput and so on.
      979b107e
  18. May 12, 2012
  19. May 08, 2012
    • Nikolaj Sjujskij's avatar
      build: fix hgrc manpage building with docutils 0.9 · 462dd183
      Nikolaj Sjujskij authored
      Since docutils 0.9, `roman` module has been moved from module directory root
      (i.e. `site-packages/roman.py`) to `docutils.utils` module. Therefore `import
      roman` statement should be wrapped in `try: ... except ImportError: ...` block
      to handle importing correctly.
      462dd183
  20. Apr 30, 2012
    • Martin Geisler's avatar
      doc: update copyright years to 2012 · e49e039a
      Martin Geisler authored
      I sometimes look at a piece of software and if the man page says
      "Copyright 2004", then I'm inclined to think that the project is stale
      or that the authors are lazy. Neither is good publicity for us :-)
      e49e039a
  21. Dec 06, 2011
  22. Oct 20, 2011
  23. Jul 25, 2011
  24. Jun 29, 2011
  25. Jun 16, 2011
  26. May 30, 2011
  27. May 13, 2011
  28. May 09, 2011
Loading