public inbox for ltp@lists.linux.it
 help / color / mirror / Atom feed
From: Petr Vorel <pvorel@suse.cz>
To: ltp@lists.linux.it
Subject: [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines
Date: Thu, 27 May 2021 16:44:12 +0200	[thread overview]
Message-ID: <YK+wPLPBEHxH5gmq@pevik> (raw)
In-Reply-To: <YK+QeafN4q6IUvOn@yuki>

> Hi!
> > Test Writing Guidelines wiki page is too long, thus split it
> > into 3 parts:

> > 1) generic part (only first chapter, the same URL)
> > 2) C test API (2.2 chapter, 4. Common problems)
> > 3) shell test API

> > Unfortunately this breaks users' bookmarks.

> > Start numbering in headers from 1 on each page (links are broken
> > anyway).

> > NOTE: in order to have '...' formatting as code,
> > main header ====== was needed to add on the page.

> The split looks good to me, acked.
Thank to you all, merged.
Unfortunately I left two things, thus two more small fixes were needed.

> > Signed-off-by: Petr Vorel <pvorel@suse.cz>
> > ---
> > See it:
> > https://github.com/pevik/ltp/wiki/Test-Writing-Guidelines

> This page should be updated, at least the paragraph about commenting code
> should now explain top level comment format.

> The backward compatibility should be improved as well, since we have
> kernel config parser now as well, etc.

> I guess that I should sit down and write a patch for that one once the
> split is applied.

Agree to all.

Kind regards,
Petr

      reply	other threads:[~2021-05-27 14:44 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-26 15:49 [LTP] [RFC PATCH 1/1] doc: Split test-writing-guidelines Petr Vorel
2021-05-27  3:31 ` Li Wang
2021-05-27  3:49   ` Li Wang
2021-05-27  4:00     ` Xie Ziyao
2021-05-27  4:19     ` Petr Vorel
2021-05-27  4:51       ` Li Wang
2021-05-27  6:02         ` Petr Vorel
2021-05-27  6:56           ` Richard Palethorpe
2021-05-27 12:28 ` Cyril Hrubis
2021-05-27 14:44   ` Petr Vorel [this message]

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=YK+wPLPBEHxH5gmq@pevik \
    --to=pvorel@suse.cz \
    --cc=ltp@lists.linux.it \
    /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