Mirror of the gdb-patches mailing list
 help / color / mirror / Atom feed
From: Philippe Waroquiers <philippe.waroquiers@skynet.be>
To: gdb-patches@sourceware.org
Subject: [RFAv2 0/2] Make first and last lines of 'command help documentation' consistent + add a test
Date: Sat, 03 Aug 2019 13:39:00 -0000	[thread overview]
Message-ID: <20190803133921.20154-1-philippe.waroquiers@skynet.be> (raw)

This patch series ensures the help doc of commands respects 2 invariants.

Patch 1 changes the code and tests so that invariants are respected;
Patch 2 implements a selftest to verify the invariants.

This is the second version of the change.

Compared to the first version, the changes are handling the comments
given by Tom and Pedro.

The changes are:
  * The test to verify the invariants is now a separate patch,
    and is implemented as a selftest, as discussed on irc.
  * Some updates to the help:
    help delete: removed "or auto-display expressions"
                 removed that unset is an alias for delete, as unset
                 is not an alias of delete.
    help interpreter-exec: after confirming that effectively
       several commands can be given, doc updated to clarify this.
    help substitute-path: replaced "source files names directories"
       by "source directories" (same wording as in the user manual).




             reply	other threads:[~2019-08-03 13:39 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-08-03 13:39 Philippe Waroquiers [this message]
2019-08-03 13:39 ` [RFAv2 1/2] Make first and last lines of 'command help documentation' consistent Philippe Waroquiers
2019-08-06 18:30   ` Tom Tromey
2019-08-03 13:39 ` [RFAv2 2/2] Add a selftest that checks documentation invariants Philippe Waroquiers
2019-08-06 18:43   ` Tom Tromey
2019-08-06 22:21     ` Philippe Waroquiers
2019-08-07  2:06       ` Tom Tromey

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=20190803133921.20154-1-philippe.waroquiers@skynet.be \
    --to=philippe.waroquiers@skynet.be \
    --cc=gdb-patches@sourceware.org \
    /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