Skip to content
Snippets Groups Projects
  1. Jul 17, 2009
  2. Jul 16, 2009
  3. Jul 13, 2009
  4. Jul 07, 2009
  5. Jun 19, 2009
  6. Jun 18, 2009
  7. Jun 04, 2009
  8. May 21, 2009
  9. May 14, 2009
  10. May 13, 2009
  11. May 12, 2009
    • Iustin Pop's avatar
      Some small doc updates · fd07c6b3
      Iustin Pop authored
      
      We change some formatting to sphinx-specific, to show how the
      documentation can be improved.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      fd07c6b3
    • Iustin Pop's avatar
      Move the glossary to a separate file · e2078d28
      Iustin Pop authored
      
      Currently we have an insignificant glossary at the end of the design-2.0
      document. This patch moves it to a separate file with the goal that it
      will grow and all files can refer to it.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      e2078d28
    • Iustin Pop's avatar
      Switch the documentation to sphinx · d17e74b4
      Iustin Pop authored
      This big patch converts the documentation build system to sphinx
      (http://sphinx.pocoo.org/
      
      ). Since that uses reStructuredText sources
      too, there is no change (yet) in the documents themselves, just in the
      build system.
      
      As before, the docs are pre built by the maintainer, and the end-user
      doesn't need sphinx or other rst tools to build the docs. Note that we
      are not distributing PDFs, so building that will require the tools.
      
      The docs will be stored under doc/html and the build system also need an
      extra directory doc/build. These are considered (by automake)
      maintainer-related objects and are removed at maintainer-clean time.
      
      The patch also fixes some small issues: add a docpng variable, add
      doc/api (also generated by maintainer) in maintainer-clean-local, etc.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      d17e74b4
    • Iustin Pop's avatar
      Convert from auto-generated RAPI docs to static · 6d81475c
      Iustin Pop authored
      
      This patch removes the autogeneration of the RAPI docs from the code
      (based on docstrings) and moves the current autogenerated output to
      the rapi.rst file.
      
      The reasons behind this are multiple:
        - the build system becomes a little more simple (this could have been
      	achieved also by distributing the built documentation, though)
        - it's hard to actually write documentation in docstrings; you have to
      	fit restructured text inside the docstrings, and this results in
      	not really nice output
        - even by being close to the code, the documentation manages to get
      	out of sync (not paying attention to docstrings)
      
      This will also help with the move to sphinx.
      
      Signed-off-by: default avatarIustin Pop <iustin@google.com>
      Reviewed-by: default avatarGuido Trotter <ultrotter@google.com>
      6d81475c
  12. May 09, 2009
  13. May 06, 2009
  14. Apr 15, 2009
    • Iustin Pop's avatar
      A bunch of doc and other small fixes · 949bdabe
      Iustin Pop authored
      This patch adds a couple of both externally and internally reported
      issues:
        - missing SGML tags (Issue 54), report and patch by superdupont
        - wrong variable used in the init.d script, report and patch by
          Karsten Keil <karsten-keil@t-online.de>
        - man page for gnt-instance reinstall needs clarification (Issue 56)
        - gnt-instance man page missing --disks documentation for
          replace-disks
        - gnt-node modify help output is unclear about the -C/-D/-O input
          format, and the man page doesn't document this command at all
        - “gnt-node modify -C yes” for offline or drained nodes had wrong
          error message
        - “gnt-instance reinstall --select-os” has wrong prompt, we only
          accept a number for the OS and not the template name
      
      Reviewed-by: ultrotter
      949bdabe
  15. Mar 12, 2009
    • Iustin Pop's avatar
      Add the 2.0-specific node flags to the design doc · e0eb13de
      Iustin Pop authored
      This patch adds the newly-introduced node flags to the design document,
      as they currently are missing from there.
      
      The patch also reduces the TOC depth to 3, as it was too big.
      
      Reviewed-by: ultrotter
      e0eb13de
  16. Mar 04, 2009
  17. Mar 02, 2009
    • Iustin Pop's avatar
      Export tags to cluster verify hooks · 35e994e9
      Iustin Pop authored
      This patch export the cluster and node tags to the cluster verify hook
      scripts. The tags are exported as a space-separated list, which allows
      easy parsing from the shell (e.g. “for tag in $GANETI_CLUSTER_TAGS; do
      ...”) and therefore requires the previous “Don't allow spaces in tag
      names” patch.
      
      The patch also fixes a minor line length style problem.
      
      Reviewed-by: ultrotter
      35e994e9
    • Iustin Pop's avatar
      Update the iallocator documentation · 77031881
      Iustin Pop authored
      This updates the iallocator documentation to 2.0, bumps up the
      iallocator version (and moves a constants to lib/constants.py), and
      fixes a style on install.rst.
      
      Reviewed-by: ultrotter
      77031881
    • Iustin Pop's avatar
      A doc update and a small indentation fix · b806661b
      Iustin Pop authored
      This adds a small paragraph about the “master” role of a node, and fixes
      a wrong indentation in the bash completion file.
      
      Reviewed-by: imsnah
      b806661b
  18. Feb 27, 2009
    • Iustin Pop's avatar
      Convert the RAPI document to restructured text · 4352bf6d
      Iustin Pop authored
      This patch changes the RAPI document, and the RAPI resources
      autogenerated-documentation to restructured text. This meant changing
      the autogen tool.
      
      The new fragment can be included via RST directives, and doesn't need
      passing through replace-sed-vars. This was also the last sgml document
      in doc/, so we remove old makefile rules about it.
      
      Reviewed-by: imsnah
      4352bf6d
    • Iustin Pop's avatar
      Convert the install document to restructured text. · 28e15341
      Iustin Pop authored
      This switches back to the hardcoding of the version number, as we don't
      yet have a wrapper for rst files that passes them through
      replace-sed-vars.
      
      Reviewed-by: imsnah
      28e15341
  19. Feb 26, 2009
    • Iustin Pop's avatar
      Add bash-completion rules · e2a2a2eb
      Iustin Pop authored
      This is a not-complete bash completion file for ganeti commands (gnt-*)
      and the burnin tool. It is based on previous work by Minghua Ye
      <yeminghua@google.com> for Ganeti 1.1, which wasn't used because the
      lack of ssconf keys (which allow easy inspection by the shell of the
      existing nodes and instances) made it too slow.
      
      The file works as expected, however I realized that our custom (like
      comma-separated, or a=b:c,e:f) options are not very nice for
      auto-completion. There are a few FIXMEs in the source for that.
      
      The file is not installed at make install time, but it should be put in
      the correct place by packages.
      
      Reviewed-by: imsnah
      e2a2a2eb
  20. Feb 25, 2009
  21. Feb 24, 2009
    • Iustin Pop's avatar
      Convert iallocator.sgml to restructured text · 876860a3
      Iustin Pop authored
      This is a no-contents change, this doc will need update to conform to
      2.0 message contents (and also the code will need increase to version 2
      of the iallocator protocol).
      
      Reviewed-by: imsnah
      876860a3
    • Iustin Pop's avatar
      Convert the admin guide to restructured text · ffa6869f
      Iustin Pop authored
      The RST format holds a little bit less information, as all the <file
      class="directory"> and <userinput> tags are gone, however we're not
      really losing important context here. And it's way easier to read and
      update.
      
      Reviewed-by: imsnah
      ffa6869f
  22. Feb 20, 2009
  23. Feb 17, 2009
  24. Feb 13, 2009
  25. Feb 10, 2009
  26. Feb 05, 2009
Loading