1. 06 Mar, 2013 2 commits
    • Iustin Pop's avatar
      Fix bug in man build rule · 67c15d8b
      Iustin Pop authored
      Currently the man page build rule is run without ‘-e’, so the actual
      checks in there are just warnings (check-man-warnings,
      check-man-dashes).
      
      The patch fixes this and also fixes the man pages which made me see the
      problem.
      
      Additionally, check-man-dashes is now verbose, otherwise it's hard to
      find out actually where in the page the error is.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarMichele Tartara <mtartara@google.com>
      67c15d8b
    • Iustin Pop's avatar
      Fix hscolour style sheet building · e61db4b2
      Iustin Pop authored
      Currently we only symlink this into two hard-coded directories, which
      breaks the source code viewing for all the others.
      
      The patch replaces this with automatic building; as playing with
      relative symlinks is non-trivial, I just generate it many times (the
      file is small enough (<250) that it shouldn't matter, size-wise, and
      it takes 2ms to do it).
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarMichele Tartara <mtartara@google.com>
      e61db4b2
  2. 05 Mar, 2013 1 commit
    • Iustin Pop's avatar
      Expand Haddock to run over test files as well · 7ddd8e4c
      Iustin Pop authored
      This patch does multiple enhancements to the way we build the Haddock
      docs, motivated by the fact that if we don't run Haddock over test
      files as well, bad formatting can be submitted and will accumulate
      over time (without any checks).
      
      The patch does:
      
      - replace manual built ALL_APIDOC_HS_DIRS with automatically built one
        (from HS_DIRS)
      - change Haddock so that it runs from the top directory (instead of
        from src/)
      - change HsColour target file to be built via bash parameter
        substitution, rather than sed (I don't know how to do it in one go,
        so I use 2 intermediate variables)
      - change 'hs-apidoc' target so that it depends on the real target
        file; in case no source file has been modified, running 'make
        hs-apidoc' twice will not result in two runs
      - run HsColour/Haddock under en_US.UTF-8 locale, otherwise they can't
        parse correctly the Unicode chars in the test files
      
      Additionally, wrong formatting (oops) in a test file has been
      corrected.
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarMichele Tartara <mtartara@google.com>
      7ddd8e4c
  3. 15 Feb, 2013 1 commit
  4. 12 Feb, 2013 2 commits
  5. 07 Feb, 2013 1 commit
  6. 05 Feb, 2013 1 commit
  7. 18 Jan, 2013 2 commits
  8. 17 Jan, 2013 1 commit
  9. 16 Jan, 2013 4 commits
  10. 15 Jan, 2013 2 commits
    • Michael Hanselmann's avatar
      Link man pages in documentation · 5ce58234
      Michael Hanselmann authored
      This patch depends on “Option to include man pages in documentation”. In
      the documentation build including man pages, all “:manpage:`…`”
      references are converted to links. For man pages not provided by Ganeti,
      Sphinx' standard formatting is used.
      
      A small dance is necessary to hook into Sphinx' processing of man page
      roles and to generate automatically resolved links. The code converts
      “:manpage:`…`” for known man pages to the data structure equivalent of
      “:doc:`$name($section) <man-$name>`”. Additionally it checks the section
      numbers and formatting of references (in all builds).
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      5ce58234
    • Michael Hanselmann's avatar
      Option to include man pages in documentation · 41806ef4
      Michael Hanselmann authored
      Before this patch, HTML versions of man pages (man/*.rst) were already
      built. However, since they are separate from the normal documentation,
      their content is not indexed for Sphinx' search functionality.
      Additionally it would simply be nice to have everything in one place.
      
      To this end a new configure-time option is added to enable the inclusion
      of man pages into the documentation. A dedicated option is necessary to
      still be able to provide a static documentation build in the tarball
      (not including man pages) as man pages contain build-specific paths and
      values. The documentation with man pages is written to the directory
      “doc/man-html”.
      
      A future patch will extend Sphinx to link occurences of “:manpage:`…`”
      to these man pages.
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      41806ef4
  11. 14 Jan, 2013 1 commit
  12. 10 Jan, 2013 2 commits
    • Michael Hanselmann's avatar
      Generate documentation from build directory · 7cf58cad
      Michael Hanselmann authored
      When man pages should be included they need to be copied from man/*.rst.
      This means documentation can no longer be built from the static reST
      files alone (which are referenced using “abs_top_srcdir”). Similar to
      Python files, automake doesn't copy or link the input files for
      documentation into the build tree.
      
      This patch adds all files required to build the documentation to
      “srclink_files”, renames the “docrst" variable to “docinput”, and then
      references the files in the build tree using “abs_top_builddir”.
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      7cf58cad
    • Michael Hanselmann's avatar
      Add script to check man page references · 58997abb
      Michael Hanselmann authored
      This script checks for some of the most obvious mistakes when formatting
      man page references (which should have the form “**ganeti**\(7)”). While
      this works now, it is very hard to avoid ambiguities (e.g. references
      within verbatim blocks) when using regular expressions.
      
      Also fixes a typo in Makefile.am by replacing “harcoded” with
      “hardcoded”.
      Signed-off-by: default avatarMichael Hanselmann <hansmi@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      58997abb
  13. 09 Jan, 2013 3 commits
  14. 08 Jan, 2013 6 commits
  15. 07 Jan, 2013 2 commits
  16. 04 Jan, 2013 1 commit
  17. 28 Dec, 2012 1 commit
  18. 27 Dec, 2012 7 commits