Issue #14759: Enhanced cmdline options documentation by tabular format #14799
Conversation
This comment was marked as duplicate.
This comment was marked as duplicate.
MANISH-K-07
force-pushed
the
tableDocs
branch
2 times, most recently
from
21b1d74
to
9796faf
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
This comment was marked as duplicate.
|
The anchors are working just as suggested at #14759 (comment) Not yet sure why the test is unable to read option -c description from doc. (failure) |
|
@romani , @rnveach , @nrmancuso , any thoughts on this ? |
The table looks great, let's make CI happy |
Still trying to debug why the |
|
@romani , @nrmancuso , |
| @@ -49,7 +49,8 @@ public void validateCliDocSections() throws Exception { | |||
| final Map<String, String> cmdDesc = new HashMap<>(); | |||
|
|
|||
| final NodeList sections = getSectionsFromXdoc("src/xdocs/cmdline.xml.vm"); | |||
| final Set<String> cmdOptions = getListById(sections.item(2), "CLI_Options"); | |||
| final Set<String> cmdOptions = | |||
| getListById(sections.item(2), "Command_line_usage_Command_line_options"); | |||
There was a problem hiding this comment.
@nrmancuso , 2 is the section index of the XML (considering 0-based), I believe.
- Content
- Description
- Command Line Usage
There was a problem hiding this comment.
@nrmancuso , could you please assign this PR to yourself.
There was a problem hiding this comment.
@nrmancuso , could you please assign this PR to yourself.
No need to assign reviewers until CI is green. CI is the first reviewer :)
There was a problem hiding this comment.
No need to assign reviewers until CI is green. CI is the first reviewer :)
Got it @nrmancuso , please see #14799 (comment).
I seem to be falling short on what I'm missing while debug 😕
Theoretically, the siblings are read only after firstChild is mapped and so on, but not sure why this (-c) is being skipped and continued to next node.
There was a problem hiding this comment.
This PR changes xml a lot, but test that does selection from this xml is not changed. getListById should be changed a bit.
There was a problem hiding this comment.
It use to be:
<ul id="CLI_Options">
<li>
<code>-c
Becomes a way more complicated and different:
....
<tbody>
<tr>
<td>
<a name="c"/>
<a href="#c">
<strong>-c</strong> configurationFile
</a>
So getListById should be rewritten.
@MANISH-K-07 , do need help to write a code?
There was a problem hiding this comment.
Will look into it at the earliest @romani
|
@MANISH-K-07 , please help to finish this PR |
#14799 (comment) still no thought on this.. |
|
Aims to close #14759
WIP ....