From: Andrew Burgess <andrew.burgess@embecosm.com>
To: "Carroll, Paul" <pcarroll@codesourcery.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH][PR gdb/25716] Modify Docs to avoid HTML filename collision on Windows
Date: Wed, 8 Jul 2020 11:42:19 +0100 [thread overview]
Message-ID: <20200708104219.GA2737@embecosm.com> (raw)
In-Reply-To: <badfe5ab-018b-22dc-e53d-638e230bc96b@codesourcery.com>
* Carroll, Paul <pcarroll@codesourcery.com> [2020-07-07 12:51:17 -0700]:
>
> On 7/7/2020 8:45 AM, Andrew Burgess wrote:
> > Lots of whitespace in this patch was replaced with '_' for some
> > reason, which means this patch didn't apply cleanly. Not sure where
> > this has occurred, but I don't see this with other patches, so I'd
> > like to say this is something at your end.
>
> Somehow an extra space was added for lines that started with a space. No
> idea how it got there. Copy-paste error.
>
> > > adjust xrefs to it.
> > >
> > > ---
> > > gdb/doc/gdb.texinfo | 5 ++---
> > > 1 file changed, 2 insertions(+), 3 deletions(-)
> > >
> > > diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> > > index 59e3e75d18..5301e98fee 100644
> > > --- a/gdb/doc/gdb.texinfo
> > > +++ b/gdb/doc/gdb.texinfo
> > > @@ -3600,7 +3600,7 @@ is, using:
> > > @end smallexample
> > >
> > > The @code{tfaas} command accepts the same options as the @code{frame
> > > -apply} command. @xref{frame apply}.
> > > +apply} command. @xref{Frame Apply, frame apply}.
> > I wonder if we should use '@xref{Frame Apply, , frame apply}.' here?
> >
> > Currently in html we get: 'See frame apply.'
> > And in a pdf we get: 'See [frame apply], page 112.'
> >
> > After this commit the html stays the same, but the pdf changes to:
> > 'See Section 8.5 [Frame Apply], page 112.'. The new 'Section xxx'
> > doesn't bother me, but 'Frame Apply' is not the name of the section,
> > nor is it the name of the command.
> >
> > With my proposed change then the html version stays the same, and the
> > pdf version becomes: 'See Section 8.5 [frame apply], page 112.', we
> > now name the actual command.
> >
> > What do you think?
> >
> > Thanks,
> > Andrew
>
> Looks good to me. there are 2 xrefs that would need the same change. From
> what I generated, the PDFs show the difference while the HTML files are
> identical. So, yes, it matches what you indicated.
>
> I'm attaching my patch with your change.
>
Normally Eli reviews documentation changes, but given there's not
really any content change here I feel I can approve this.
Thanks,
Andrew
> ---
> gdb/doc/gdb.texinfo | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
> index 59e3e75d18..5301e98fee 100644
> --- a/gdb/doc/gdb.texinfo
> +++ b/gdb/doc/gdb.texinfo
> @@ -3600,7 +3600,7 @@ is, using:
> @end smallexample
>
> The @code{tfaas} command accepts the same options as the @code{frame
> -apply} command. @xref{frame apply}.
> +apply} command. @xref{Frame Apply,,frame apply}.
>
> @kindex thread name
> @cindex name a thread
> @@ -8358,7 +8358,6 @@ tfaas i lo -q -t lock_something_t
>
> @node Frame Apply
> @section Applying a Command to Several Frames.
> -@anchor{frame apply}
> @kindex frame apply
> @cindex apply command to several frames
> @table @code
> @@ -8490,7 +8489,7 @@ is, using:
> @end smallexample
>
> The @code{faas} command accepts the same options as the @code{frame
> -apply} command. @xref{frame apply}.
> +apply} command. @xref{Frame Apply,,frame apply}.
>
> Note that the command @code{tfaas @var{command}} applies @var{command}
> on all frames of all threads. See @xref{Threads,,Threads}.
> --
> 2.21.0
>
next prev parent reply other threads:[~2020-07-08 10:42 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-19 16:41 Carroll, Paul
2020-07-07 15:45 ` Andrew Burgess
2020-07-07 19:51 ` Carroll, Paul
2020-07-08 10:42 ` Andrew Burgess [this message]
2020-07-08 18:13 ` Eli Zaretskii
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200708104219.GA2737@embecosm.com \
--to=andrew.burgess@embecosm.com \
--cc=gdb-patches@sourceware.org \
--cc=pcarroll@codesourcery.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).