On Fri 2025-08-01 14:52:07, Gerald Pfeifer wrote:
> On Tue, 29 Jul 2025, Filip Kastl wrote:
> > okay to push?  Confirmed that I didn't break anything by running `make 
> > html`.
> 
> ...and `make pdf`?

Ah, thanks.  Also checked make pdf.

> > This patch changes two things.  Firstly, we document
> > -fdump-rtl-<whatever>-graph and other such options under -fdump-tree.
> > At least write a remark about this under -fdump-rtl.  Secondly, the
> > documentation incorrectly says that -fdump-tree-<whatever>-graph is not
> > implemented.
> 
> This definitely looks like a nice enhancement; thank you for taking the 
> time to do so.
> 
> > +@option{-fdump-rtl}.  This is used for debugging the RTL-based passes of 
> > the
> >  compiler.
> 
> This line looks a little long?

The line is under 80 chars, so should be ok.

> > +Here are the possible keywords for @var{pass} and letters for 
> > @var{letters},
> > +and their meanings:
> >  
> >  @table @gcctabopt
> 
> Looking at the table, it doesn't actually just list values for @var{pass} 
> and @var{letters}, if shows fuller options? (That is, it lists "-da" 
> rather than just "a".)
> 
> How about using something like "Here are actual instances of command-line 
> options following these patterns" (or something different)?

Sounds good.  Chose to go with that plus "and their meanings:".

> 
> Okay if you take the above into consideration. Happy to look at an updated 
> patch, alas not required.
> 
> Gerald

Commited.

Thanks for the review!
Filip Kastl

-- 8< --

This patch changes two things.  Firstly, we document
-fdump-rtl-<whatever>-graph and other such options under -fdump-tree.
At least write a remark about this under -fdump-rtl.  Secondly, the
documentation incorrectly says that -fdump-tree-<whatever>-graph is not
implemented.  Change that.

gcc/ChangeLog:

        * doc/invoke.texi: Add remark about -options being documented
        under -fdump-tree.  Remove remark about -graph working only for
        RTL.

Signed-off-by: Filip Kastl <fka...@suse.cz>
---
 gcc/doc/invoke.texi | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

diff --git a/gcc/doc/invoke.texi b/gcc/doc/invoke.texi
index c1e708beacf..105a60d849f 100644
--- a/gcc/doc/invoke.texi
+++ b/gcc/doc/invoke.texi
@@ -20612,18 +20612,22 @@ LTO output files.
 @opindex fdump-rtl-@var{pass}
 @item -d@var{letters}
 @itemx -fdump-rtl-@var{pass}
-@itemx -fdump-rtl-@var{pass}=@var{filename}
+@itemx -fdump-rtl-@var{pass}-@var{options}
+@itemx -fdump-rtl-@var{pass}-@var{options}=@var{filename}
 Says to make debugging dumps during compilation at times specified by
-@var{letters}.  This is used for debugging the RTL-based passes of the
+@var{letters} when using @option{-d} or by @var{pass} when using
+@option{-fdump-rtl}.  This is used for debugging the RTL-based passes of the
 compiler.
 
 Some @option{-d@var{letters}} switches have different meaning when
 @option{-E} is used for preprocessing.  @xref{Preprocessor Options},
 for information about preprocessor-specific dump options.
 
-Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
-@option{-d} option @var{letters}.  Here are the possible
-letters for use in @var{pass} and @var{letters}, and their meanings:
+The @samp{-@var{options}} form allows greater control over the details of the
+dump. See @option{-fdump-tree}.
+
+Here are actual instances of command-line options following these patterns and
+their meanings:
 
 @table @gcctabopt
 
@@ -21150,8 +21154,7 @@ GraphViz to 
@file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
 the file is pretty-printed as a subgraph, so that GraphViz can render them
 all in a single plot.
 
-This option currently only works for RTL dumps, and the RTL is always
-dumped in slim form.
+RTL is always dumped in slim form.
 @item vops
 Enable showing virtual operands for every statement.
 @item lineno
-- 
2.49.0

Reply via email to