linux-kernel - Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with ReST output

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives
Hash Suite: Windows password security audit tool. GUI, reports in PDF.
[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20201028174427.GE9364@hoboy.vegasvil.org>
Date:   Wed, 28 Oct 2020 10:44:27 -0700
From:   Richard Cochran <richardcochran@...il.com>
To:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Mauro Carvalho Chehab <mchehab+samsung@...nel.org>,
        "Gautham R. Shenoy" <ego@...ux.vnet.ibm.com>,
        "Jason A. Donenfeld" <Jason@...c4.com>,
        Javier González <javier@...igon.com>,
        Jonathan Corbet <corbet@....net>,
        "Martin K. Petersen" <martin.petersen@...cle.com>,
        "Rafael J. Wysocki" <rjw@...ysocki.net>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        Alexandre Belloni <alexandre.belloni@...tlin.com>,
        Alexandre Torgue <alexandre.torgue@...com>,
        Andrew Donnellan <ajd@...ux.ibm.com>,
        Andy Shevchenko <andriy.shevchenko@...ux.intel.com>,
        Baolin Wang <baolin.wang7@...il.com>,
        Benson Leung <bleung@...omium.org>,
        Boris Ostrovsky <boris.ostrovsky@...cle.com>,
        Bruno Meneguele <bmeneg@...hat.com>,
        Chunyan Zhang <zhang.lyra@...il.com>,
        Dan Murphy <dmurphy@...com>,
        Dan Williams <dan.j.williams@...el.com>,
        Enric Balletbo i Serra <enric.balletbo@...labora.com>,
        Fabrice Gasnier <fabrice.gasnier@...com>,
        Felipe Balbi <balbi@...nel.org>,
        Frederic Barrat <fbarrat@...ux.ibm.com>,
        Guenter Roeck <groeck@...omium.org>,
        Hanjun Guo <guohanjun@...wei.com>,
        Heikki Krogerus <heikki.krogerus@...ux.intel.com>,
        Jens Axboe <axboe@...nel.dk>,
        Johannes Thumshirn <johannes.thumshirn@....com>,
        Jonathan Cameron <jic23@...nel.org>,
        Juergen Gross <jgross@...e.com>,
        Konstantin Khlebnikov <koct9i@...il.com>,
        Kranthi Kuntala <kranthi.kuntala@...el.com>,
        Lakshmi Ramasubramanian <nramas@...ux.microsoft.com>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Len Brown <lenb@...nel.org>,
        Leonid Maksymchuk <leonmaxx@...il.com>,
        Ludovic Desroches <ludovic.desroches@...rochip.com>,
        Mario Limonciello <mario.limonciello@...l.com>,
        Maxime Coquelin <mcoquelin.stm32@...il.com>,
        Michael Ellerman <mpe@...erman.id.au>,
        Mika Westerberg <mika.westerberg@...ux.intel.com>,
        Mike Kravetz <mike.kravetz@...cle.com>,
        Mimi Zohar <zohar@...ux.ibm.com>,
        Nayna Jain <nayna@...ux.ibm.com>,
        Nicolas Ferre <nicolas.ferre@...rochip.com>,
        Niklas Cassel <niklas.cassel@....com>,
        Oleh Kravchenko <oleg@....org.ua>,
        Orson Zhai <orsonzhai@...il.com>, Pavel Machek <pavel@....cz>,
        Pawan Gupta <pawan.kumar.gupta@...ux.intel.com>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        Peter Rosin <peda@...ntia.se>, Petr Mladek <pmladek@...e.com>,
        Philippe Bergheaud <felix@...ux.ibm.com>,
        Sebastian Reichel <sre@...nel.org>,
        Sergey Senozhatsky <sergey.senozhatsky@...il.com>,
        Stefano Stabellini <sstabellini@...nel.org>,
        Thinh Nguyen <Thinh.Nguyen@...opsys.com>,
        Thomas Gleixner <tglx@...utronix.de>,
        Vineela Tummalapalli <vineela.tummalapalli@...el.com>,
        Vishal Verma <vishal.l.verma@...el.com>,
        linux-acpi@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
        linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-mm@...ck.org, linux-pm@...r.kernel.org,
        linux-stm32@...md-mailman.stormreply.com,
        linux-usb@...r.kernel.org, linuxppc-dev@...ts.ozlabs.org,
        netdev@...r.kernel.org, xen-devel@...ts.xenproject.org
Subject: Re: [PATCH 20/33] docs: ABI: testing: make the files compatible with
 ReST output

On Wed, Oct 28, 2020 at 03:23:18PM +0100, Mauro Carvalho Chehab wrote:

> diff --git a/Documentation/ABI/testing/sysfs-uevent b/Documentation/ABI/testing/sysfs-uevent
> index aa39f8d7bcdf..d0893dad3f38 100644
> --- a/Documentation/ABI/testing/sysfs-uevent
> +++ b/Documentation/ABI/testing/sysfs-uevent
> @@ -19,7 +19,8 @@ Description:
>                  a transaction identifier so it's possible to use the same UUID
>                  value for one or more synthetic uevents in which case we
>                  logically group these uevents together for any userspace
> -                listeners. The UUID value appears in uevent as
> +                listeners. The UUID value appears in uevent as:

I know almost nothing about Sphinx, but why have one colon here ^^^ and ...

> +
>                  "SYNTH_UUID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" environment
>                  variable.
>  
> @@ -30,18 +31,19 @@ Description:
>                  It's possible to define zero or more pairs - each pair is then
>                  delimited by a space character ' '. Each pair appears in
>                  synthetic uevent as "SYNTH_ARG_KEY=VALUE". That means the KEY
> -                name gains "SYNTH_ARG_" prefix to avoid possible collisions
> +                name gains `SYNTH_ARG_` prefix to avoid possible collisions
>                  with existing variables.
>  
> -                Example of valid sequence written to the uevent file:
> +                Example of valid sequence written to the uevent file::

... two here?

Thanks,
Richard