etc: import changes to texi2pod.pl from gcc
Sync binutils' texi2pod.pl script with GCC's, adding @option and @table @option support.
Andrew Burgess proposes syncing binutils’ texi2pod.pl script with the version from GCC. This addresses limitations in formatting @option{—text} and @table @option, which were affecting GDB documentation cleanup. The imported GCC version required local adjustments to support —no-split, TARGET as a man page section, and to revert a GCC change that affected list formatting. Burgess also added trivial support for @table @option, which has been submitted to the GCC mailing list.
- proposer
Proposes syncing binutils' texi2pod.pl with GCC's version to fix @option and @table @option formatting issues, incorporating local modifications.
“I was looking at making some cleanup in the GDB documentation and I ran into a limitation of the texi2pod.pl script, it is not able to correctly format: '@option{--text}' or '@table @option'. Patching our copy of texi2pod.pl is easy enough, but it is probably better to just sync with gcc's version of the script, which already has some @option support in place. I took the version from gcc commit…”
In Details
This patch updates binutils' local copy of texi2pod.pl, a script used to convert Texinfo documentation to POD format for man pages. It imports changes from GCC's version to improve support for @option and @table within man pages, addressing specific formatting issues encountered in GDB documentation. Local adjustments were necessary to maintain compatibility with binutils' existing features and past commits.
- texi2pod.pl
- A Perl script that converts Texinfo markup (used for documentation in GNU projects) into POD (Plain Old Documentation) format, commonly used for man pages.
- @option
- A Texinfo command used to denote command-line options within documentation.
- @table @option
- A Texinfo construct used to create a list of options, where each item is introduced by the @option command.
- man pages
- Manual pages, the traditional documentation system on Unix-like operating systems, providing reference information about commands and utilities.