Uploaded image for project: 'Couchbase Server'
  1. Couchbase Server
  2. MB-52088

[Backup] Correctly install/load documentation for the tools separate package

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Major
    • 7.1.2
    • 7.1.0
    • tools
    • 1

    Description

      What's the issue?
      The tools separate package currently doesn't contain any of our documentation (at least I don't believe it does, we should double check)?

      All the tools in 'backup' will load documentation when the user uses the 'help' command or '--help' flag.

      At the moment, it's likely that this would fail, as we'd fail to find/open the documentation.

      What's the fix?
      We should install the documentation into the standalone package (probably) using the docs/CmakeLists.txt file.

      We should update logic so that we can correctly open the documentation in this new location; this will likely require extending the compile time options to set the type of install.

      https://github.com/couchbase/backup/blob/30685d694149f500455430863ba2f219743c5b93/docs/CMakeLists.txt
      https://github.com/couchbase/backup/blob/30685d694149f500455430863ba2f219743c5b93/man/man.go#L41-L45
      https://github.com/couchbase/backup/blob/30685d694149f500455430863ba2f219743c5b93/man/man_unix.go#L15-L21

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              gilad.kalchheim Gilad Kalchheim
              james.lee James Lee
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty