All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andrea Cervesato via ltp <ltp@lists.linux.it>
To: Linux Test Project <ltp@lists.linux.it>
Subject: [LTP] [Open discussion] docparse handling
Date: Mon, 10 Feb 2025 13:25:49 +0100	[thread overview]
Message-ID: <34c1451a-2adb-4efd-874b-e2d9b660e56f@suse.com> (raw)

Hi all,

we just added a test catalog in the LTP documentation [1], but most of 
the tests are still using asciidoc as the main tests' description 
syntax. Obviously, we need to switch to RST [2] syntax, that is now used 
in the whole LTP documentation along with sphinx [3] support.

I would like to introduce a discussion on this topic, since I seen a few 
patches meant to adapt old tests' descriptions [4] into asciidoc and we 
don't really want to double our job. In particular:

- is [Description] tag still needed? Shall we use **Description** instead?
- shall we start to convert all tests' descriptions into asciidoc? If 
yes, how? Automatically or manually?

Best regards,
Andrea Cervesato

[1] 
https://linux-test-project.readthedocs.io/en/latest/users/test_catalog.html
[2] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
[3] https://www.sphinx-doc.org/en/master/index.html
[4] 
https://patchwork.ozlabs.org/project/ltp/patch/20250210091044.359274-1-maxj.fnst@fujitsu.com/


-- 
Mailing list info: https://lists.linux.it/listinfo/ltp

             reply	other threads:[~2025-02-10 12:26 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-02-10 12:25 Andrea Cervesato via ltp [this message]
2025-02-10 13:15 ` [LTP] [Open discussion] docparse handling pvorel

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=34c1451a-2adb-4efd-874b-e2d9b660e56f@suse.com \
    --to=ltp@lists.linux.it \
    --cc=andrea.cervesato@suse.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.