ros-infrastructure / rosdoc2

Command-line tool for generating documentation for ROS 2 packages.
Apache License 2.0
29 stars 9 forks source link

Package fastrtps times out, and then generates no output #103

Open rkent opened 2 months ago

rkent commented 2 months ago

Yet they have a nice README which would be useful to include, as well as other useful info in package.xml. Perhaps we could graylist certain packages to disable doxygen when we know our attempt to run it will be fruitless.

tfoote commented 2 months ago

In general for this sort of outlier I think that we should push back on the maintainers to tell them to adjust their configuration to build in a reasonable amount of time.

I've manually temporarily extended the build timeout to see how long it runs https://build.ros2.org/view/Rdoc/job/Rdoc__fastrtps__ubuntu_noble_amd64/14

tfoote commented 2 months ago

This build took 3 hours and 26 minutes and generated 7GB in some 3000 files for https://docs.ros.org/en/rolling/p/fastrtps

fastrtps]$ du -hcs *
7.0G    generated
3.5M    genindex.html
1.9M    index.html
620K    objects.inv
4.0K    objects.inv.location.json
1.9M    search.html
3.3M    searchindex.js
17M _sources
4.0M    _static
7.0G    total
fastrtps]$ ls generated/ | wc -l
3798
fastrtps]$ du -hcs generated/* | sort -h | tail -n 10
2.0M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastdds_dds_core_policy_ParameterTypes.hpp.html
2.0M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastdds_rtps_messages_CDRMessage.hpp.html
2.0M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastrtps_types_AnnotationParameterValue.h.html
2.0M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastrtps_types_dds-xtypes_typeobject.idl.html
2.0M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastrtps_types_TypeIdentifierTypes.h.html
2.1M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastdds_dds_core_policy_QosPolicies.hpp.html
2.6M    generated/index.html
2.8M    generated/program_listing_file__tmp_ws_src_fastrtps_include_fastrtps_types_TypeObject.h.html
287M    generated/doxygen
7.0G    total

There is a lot of files, but we also have a lot of repeated files for some reason like this:

1.8M    generated/variable_fastdds_2rtps_2transport_2TransportInterface_8h_1a091d744f00f39a77de64824c04d38a8b.html
1.8M    generated/variable_fastdds_2rtps_2transport_2TransportInterface_8h_1a0f9c6579d28a9ea0de1408325614f25e.html
1.8M    generated/variable_fastdds_2rtps_2transport_2TransportInterface_8h_1a556df183823e036c2e1896c798af43b3.html
1.8M    generated/variable_fastdds_2rtps_2transport_2TransportInterface_8h_1a9cecb07d27c5986e4c78999dc80ad0a6.html
1.8M    generated/variable_fastdds_2rtps_2transport_2TransportInterface_8h_1ae0fe299d766f3a34ea8a47811f6b94ee.html
1.8M    generated/variable_fastdds_2statistics_2dds_2publisher_2qos_2DataWriterQos_8hpp_1ac2a11de08ad57b3d425726f1d6b5354f.html
1.8M    generated/variable_fastdds_2statistics_2dds_2subscriber_2qos_2DataReaderQos_8hpp_1aa7c73174c278c6b79523cd0ec51ae64e.html
1.8M    generated/variable_FlowControllerConsts_8hpp_1a03700e5c25ca2f3c1c936ef1ab7459d8.html
1.8M    generated/variable_FlowControllerConsts_8hpp_1abc9ce7a34a616c34811248bdc481f23f.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga118b6d27b23c3f302353f2b2c9c2feaf.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga296f613a50637f069051a4b7e7346cd6.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga3701df41dc6146242937f464d69c4a0e.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga70b53a0e794ab9597d5ee4b45c10c8aa.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga720441119d12caa88f9b3196c70370d7.html
1.8M    generated/variable_group__PARAMETER__MODULE_1ga87ff1c0a3130912f3fe01e1e39570e57.html
1.8M    generated/variable_group__PARAMETER__MODULE_1gae4c1eedfdf5a491b6d78ae0b91a852d7.html
1.8M    generated/variable_InstanceState_8hpp_1a2167fa9ae43cd9a9d77267d930586dbc.html
1.8M    generated/variable_InstanceState_8hpp_1aafab0224d97b3bd05a442f15b44c7090.html
1.8M    generated/variable_LengthUnlimited_8hpp_1ab56b213f551596d93632f019a4171d6a.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a0aeaf822199733fce8ed48dd4aeff5b4.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a0d94fec73508647ce9dec5f4915b5415.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a14f47e6b414379388061b53f370068c2.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a1a0854f72b82417c641d24722a49ed64.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a1cf64cae22880b7b0bbeddaf57744207.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a1df816ab5b85e1c27bb209932d61de25.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a2c765c5ca240f8469affb0590cf594e9.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a2f772de665c27380fd0f379a64c09845.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a2fc4e7312d474780cc6cfcffd4f9c343.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a40d987323541087c1393b56e508a688f.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a49ebc23219a27cf22b1aacc958a3083b.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a4aba8c2260d1d1b400d2ec3c37c39418.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a4f255e50537f2810e289fea0f27a3571.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a5891e1f83843b6bbc5c42881964c287b.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a5d9e863b684fca7d7695781a3e6c1107.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a61cdb1fcaf7a5fb29493d482ed8c5899.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a6244c8d3828ac482ef1431165a4ce269.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a684e2e1270a883d2f5965f037b24362f.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a6f1a34971d42336d47147664f7cb8c0e.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a73278ba949d3432aabad7960e365ec67.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a7327fb6191181f283be7619e3f248685.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a73e07359f5b33607188b07c9cb3ee710.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a7c7a99a1a1cff742136ecebeebd99f2f.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a81c102b017a17102926bb35faf83a659.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a822e18e50cfffa0cc1ef0dab58961a87.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a8b2699cee65f1f23beddff8e0cd01ded.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1a98dc09cb14ae8058af7189dc38756d33.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1aa6fca6d371a0c125c045d246a6ad4b44.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1aa9811dd7cd8e79b3d69e6cef4dc99af8.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1aaad2e263614803ed8a061ed98f6acec8.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1aae5d630813349491ca5acafe20002d31.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ab10b57200b403b5cd5529c96afff9425.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1abc46ac69fce3c0a5a296e881f61b69df.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1abd0a4e030f621db9aec3755335c4b8e7.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ac17c429509c0fbdde60e19a90f5ba1fd.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ac859e895e761a6ce1c89e50557fb8ece.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1acab0700ef6397707bc8dd8a15794aa50.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ad0f7493aa534e8e5580a5a8490a0809e.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ad57f84325739c59d36c5f7d5142f0183.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ad77a2faed67708bbff70f11660235f07.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1ae8b7ba1c9974f6f9798d8d0bb81f6095.html
1.8M    generated/variable_namespaceeprosima_1_1fastrtps_1_1rtps_1af5eb53fb47a62252d79c7064444b3c3f.html

The TOC seems to still be a large fraction of the content even with #89