etc: import changes to texi2pod.pl from gcc
Binutils' texi2pod.pl script updated by importing changes from GCC, including improved @option and @table support, with necessary local adjustments.
The texi2pod.pl script in Binutils has been updated by importing recent changes from GCC’s version. This addresses limitations in handling @option{--text} and @table @option for documentation generation. Several local adjustments were made to accommodate Binutils-specific needs, such as support for --no-split and TARGET sections, and reverting a GCC commit that broke list formatting. The change also updates the script’s license from GPLv2 to GPLv3.
- proposer
Proposes updating Binutils' `texi2pod.pl` by syncing with GCC's version, detailing the necessary local modifications and explaining the rationale.
“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.”
In Details
This patch updates the texi2pod.pl script within the Binutils repository, which is responsible for converting Texinfo documentation into Pod format (used by Perl and others). The update primarily synchronizes with GCC's texi2pod.pl, bringing in fixes for handling @option directives and @table @option constructs. The author had to re-introduce several local changes specific to Binutils' build and documentation system, including support for --no-split, TARGET sections, and reverting a problematic GCC commit.
- texi2pod.pl
- A Perl script used in GNU projects to convert Texinfo documentation format into Pod (Plain Old Documentation) format, which is used by Perl and other tools.
- Texinfo
- A documentation system and format used by the GNU project. It can output to multiple formats, including HTML, PDF, and Info files.
- Pod
- Plain Old Documentation. A simple markup language used for documenting Perl modules and scripts, and also used by other projects like GNU's texi2pod.pl.
- @option
- A Texinfo command used to format command-line options within documentation.
- @table
- A Texinfo command used to create lists or tables of items, often used for options or commands.
- GPLv2 / GPLv3
- GNU General Public License version 2 and version 3. Open-source licenses that govern the distribution and modification of software. GPLv3 is a later, more comprehensive version.