[
https://issues.apache.org/jira/browse/CASSANDRA-17687?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17749466#comment-17749466
]
Jacek Lewandowski commented on CASSANDRA-17687:
-----------------------------------------------
I don't know why it was disabled. But I think it should work since we have that
in our build script. If it produces tons of warnings - those should be
investigated and addressed. Otherwise, if API docs are unneeded and nobody uses
that, let's remove the target from Ant build entirely.
I've just tried and noticed that most warnings are something like "_missing
description for tag xxx_". This isn't harmful. However, even when I disabled
alerts in linter, there stayed many more severe things which may lead to
creating broken doc pages (just needed to add {{-Xdoclint:none}} to the
options) - mainly something like "_invalid usage of tag xxx_". Let's address at
least those warnings and disable checking missing descriptions in the linter so
that we get rid of the rest.
Other than that I've noticed this:
{noformat}
gen-asciidoc:
[exec] python3 ./scripts/gen-nodetool-docs.py
[exec] python3 ./scripts/convert_yaml_to_adoc.py ../conf/cassandra.yaml
./modules/cassandra/pages/configuration/cass_yaml_file.adoc
[exec] Traceback (most recent call last):
[exec] File
"/home/jlewandowski/dev/cassandra/trunk/doc/./scripts/convert_yaml_to_adoc.py",
line 144, in <module>
[exec] convert(yaml_file, dest_file)
[exec] File
"/home/jlewandowski/dev/cassandra/trunk/doc/./scripts/convert_yaml_to_adoc.py",
line 61, in convert
[exec] with open(dest_file, 'w') as outfile:
[exec] FileNotFoundError: [Errno 2] No such file or directory:
'./modules/cassandra/pages/configuration/cass_yaml_file.adoc'
[exec] make: *** [Makefile:26: gen-asciidoc] Error 1
[exec] Result: 2
{noformat}
Do you see that as well? Seems like it is also not being caught by CI...
> Remove "--frames" option when generating javadoc
> ------------------------------------------------
>
> Key: CASSANDRA-17687
> URL: https://issues.apache.org/jira/browse/CASSANDRA-17687
> Project: Cassandra
> Issue Type: Improvement
> Components: Build
> Reporter: Zili Chen
> Assignee: Zili Chen
> Priority: Normal
> Fix For: 5.x
>
> Attachments: signature.asc
>
> Time Spent: 20m
> Remaining Estimate: 0h
>
> JDK17 doesn't support this option and it seems not quite necessary. For
> forward compatibility I propose we can remove this option.
> Related JDK issue: [https://bugs.openjdk.org/browse/JDK-8215599]
> I volunteer to prepare a patch if this is in a good direction.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
