[
https://issues.apache.org/jira/browse/CLI-308?focusedWorklogId=660031&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-660031
]
ASF GitHub Bot logged work on CLI-308:
--------------------------------------
Author: ASF GitHub Bot
Created on: 05/Oct/21 01:08
Start Date: 05/Oct/21 01:08
Worklog Time Spent: 10m
Work Description: adamburkegh commented on pull request #63:
URL: https://github.com/apache/commons-cli/pull/63#issuecomment-933976112
Hi @garydgregory
The current version of
https://github.com/apache/commons-cli/blob/master/src/site/xdoc/usage.xml
doesn't match the generated version on
https://commons.apache.org/proper/commons-cli/usage.html . A quick way to see
this is to search for `withArgName` in both files. There are about a dozen
references in the prod website but only two in `usage.xml`. The current web
version is being generated from a much older version of `usage.xml` before the
bulk of the examples were updated. I had some more detail [in
jira](https://issues.apache.org/jira/browse/CLI-308) but probably should have
put more context here.
The generation of the site by the antrun section in `pom.xml` is broken on
master, and you get errors running the task, but doesn't fail the build. There
is some other defaulting going on that means the old version is picked up. The
fix in `pom.xml` is needed for doco generation to run properly from the current
xml files in git. Without it the website doco won't update and will continue
using a default file from ~2017.
The documentation change to `usage.xml` is a small cleanup I just noticed on
the way.
The second commit to the generic apache xml and contributor files was my
attempt to follow the dev guide.
Hope that explains the intent better.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 660031)
Time Spent: 40m (was: 0.5h)
> Website has very out of date usage (site generation issue)
> ----------------------------------------------------------
>
> Key: CLI-308
> URL: https://issues.apache.org/jira/browse/CLI-308
> Project: Commons CLI
> Issue Type: Bug
> Components: Documentation
> Affects Versions: 1.4, 1.5
> Environment: Production
> Reporter: Adam Burke
> Priority: Minor
> Time Spent: 40m
> Remaining Estimate: 0h
>
> At time of writing the website at
> [https://commons.apache.org/proper/commons-cli/usage.html] has very out of
> date usage examples, eg,
>
> {{Option logfile = OptionBuilder.withArgName( "file" )
> .hasArg()
> .withDescription( "use given file for log" )
> .create( "logfile" );}}
> At first I thought this was just documentation neglect, but digging around a
> little, it seems like the doco in git is pretty up to date, and site
> generation was accidentally broken in December with a dependabot upgrade to
> the maven antrun plugin. An old version from svn gets picked up instead
> https://svn.apache.org/repos/infra/websites/production/commons/content/proper/commons-cli/usage.html
> I have a small patch as a possible fix.
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
