search

ngageoint / hootenanny-rpms

RPMs needed for a Hootenanny install
GNU General Public License v3.0
5 stars 4 forks source link

Need to include some additional /docs asciidoc files for hoot command help #296

Closed brianhatchl closed 3 years ago

brianhatchl commented 4 years ago

At this point I'm aware of those under /docs/commands but there may be more.

@bwitham @bmarchant any input on this issue?

bwitham commented 4 years ago

What kind of documentation are you adding? Something to an existing command? Yeah, each command has its own asciidoc under docs/commands.

brianhatchl commented 4 years ago

Error when running hoot changeset-apply with no args to get command help:

22:46:38.384 ERROR  .../hoot/core/cmd/BaseCommand.cpp(  57) Error opening command help for reading. (/var/lib/hootenanny/docs/commands/changeset-apply.asciidoc) Is HOOT_HOME set properly?
22:46:38.384 WARN   (   0) QIODevice::read (QFile, "/var/lib/hootenanny/docs/commands/changeset-apply.asciidoc"): device not open

Meaning I think the RPMs need to deploy some of those asciidocs to enable this help feature.

bwitham commented 4 years ago

Ok, yes that dir needs to be installed to get command line help.

bmarchant commented 4 years ago

When adding the $HOOT_HOME/docs/commands/*.asciidoc files to the RPM, there is a subdirectory archive that doesn't need to be installed. In fact, we ought to just delete it. If we ever need those files (which I don't see us ever doing) they are stored in the history. @bwitham what do you think? Delete them?

bwitham commented 4 years ago

Just move them somewhere else. I'd like to keep them for historical purposes.

bmarchant commented 4 years ago

They are fine there. I just didn't think we needed them. But I'm ok with leaving them there, we just shouldn't add them to the RPM then.