Details

    • Type: Bug
    • Status: In Progress
    • Priority: Major
    • Resolution: Unresolved
    • Affects Version/s: 1.1.6
    • Fix Version/s: .backlog1.x
    • Component/s: Infrastructure
    • Security Level: Public
    • Labels:
      None

      Description

      Current javadoc build process does not include the spymemcached docs, which were included in previous releases. The documentation:

      http://hub.internal.couchbase.com/confluence/display/techpubs/Using+Existing+Docs+System+%28WIP%29

      does not mention how to include, nor is there evidence of how it was done before.

      Need to have:

      • a process that includes correct third-party documentation, when required.
      • one that is not tied to a particular host
      • is fully documented

        Issue Links

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

          Activity

          Hide
          plabee Phil Labee (Inactive) added a comment -

          I modified the couchbase-java-client/build.xml file to also use the source files under

          ../spymemcached/src/main/java/

          for generating javadocs, but I'm getting errors:

          package org.apache.log4j does not exist
          package org.springframework.beans.factory does not exist

          so it looks like a classpath issue.

          Show
          plabee Phil Labee (Inactive) added a comment - I modified the couchbase-java-client/build.xml file to also use the source files under ../spymemcached/src/main/java/ for generating javadocs, but I'm getting errors: package org.apache.log4j does not exist package org.springframework.beans.factory does not exist so it looks like a classpath issue.
          Hide
          daschl Michael Nitschinger added a comment -

          Hi Phil,

          normally log4j and spring beans are configured as "provided", so you should not need them during runtime in spy. maybe just run "ant jar" once in the directory so it fetches the dependencies in the right directories?

          Show
          daschl Michael Nitschinger added a comment - Hi Phil, normally log4j and spring beans are configured as "provided", so you should not need them during runtime in spy. maybe just run "ant jar" once in the directory so it fetches the dependencies in the right directories?
          Hide
          plabee Phil Labee (Inactive) added a comment -

          commit 0b2ddd7de1e963f1ad3e4817ee55c5ef7bc70901 adds to "docsjar" target to include spymemcached in docs jarfile

          Requires spymemcached repo clones to workspace as peer to couchbase-java-client (or modify the extern.root property).

          Show
          plabee Phil Labee (Inactive) added a comment - commit 0b2ddd7de1e963f1ad3e4817ee55c5ef7bc70901 adds to "docsjar" target to include spymemcached in docs jarfile Requires spymemcached repo clones to workspace as peer to couchbase-java-client (or modify the extern.root property).
          Hide
          plabee Phil Labee (Inactive) added a comment -

          The generated ZIP file doesn't work right. It contains the docs from both projects, but I need to collate the package list files so that they appear together. Right now there are two copies of the top level html file (e.g. allclasses-frame.html) so depending on whether you answer yes or no to overwrite when unzipping, you get either the couchbase or the spymemcached files displayed.

          Next step is to build the zip file with the proper index files.

          Show
          plabee Phil Labee (Inactive) added a comment - The generated ZIP file doesn't work right. It contains the docs from both projects, but I need to collate the package list files so that they appear together. Right now there are two copies of the top level html file (e.g. allclasses-frame.html) so depending on whether you answer yes or no to overwrite when unzipping, you get either the couchbase or the spymemcached files displayed. Next step is to build the zip file with the proper index files.
          Hide
          ingenthr Matt Ingenthron added a comment -

          Phil: the idea is to use the javadoc command once using both projects as input, and then javadoc will build the appropriate indexes. Something like:

          javadoc /path/to/couchbase-client/* /path/to/spymemcached/*

          Show
          ingenthr Matt Ingenthron added a comment - Phil: the idea is to use the javadoc command once using both projects as input, and then javadoc will build the appropriate indexes. Something like: javadoc /path/to/couchbase-client/* /path/to/spymemcached/*
          Hide
          daschl Michael Nitschinger added a comment -

          Phil,

          is the process finished and automated by now?

          Show
          daschl Michael Nitschinger added a comment - Phil, is the process finished and automated by now?

            People

            • Assignee:
              plabee Phil Labee (Inactive)
              Reporter:
              plabee Phil Labee (Inactive)
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated: