Re: [PATCH v1 1/1] misc: IBM Virtual Management Channel Driver

From: Randy Dunlap <rdunlap@infradead.org>
To: Greg KH <gregkh@linuxfoundation.org>
Cc: "Bryant G. Ly" <bryantly@linux.vnet.ibm.com>,
	benh@kernel.crashing.org, mpe@ellerman.id.au, arnd@arndb.de,
	corbet@lwn.net, seroyer@linux.vnet.ibm.com,
	mrochs@linux.vnet.ibm.com, adreznec@linux.vnet.ibm.com,
	fbarrat@linux.vnet.ibm.com, davem@davemloft.net,
	linus.walleij@linaro.org, akpm@linux-foundation.org,
	mikey@neuling.org, pombredanne@nexb.com,
	tlfalcon@linux.vnet.ibm.com, msuchanek@suse.de,
	linux-doc@vger.kernel.org, linuxppc-dev@lists.ozlabs.org
Subject: Re: [PATCH v1 1/1] misc: IBM Virtual Management Channel Driver
Date: Tue, 24 Apr 2018 08:21:20 -0700	[thread overview]
Message-ID: <f8f39907-82c8-cf73-bcb2-3601c56c7c09@infradead.org> (raw)
In-Reply-To: <20180424142918.GA2459@kroah.com>

On 04/24/2018 07:29 AM, Greg KH wrote:
> On Mon, Apr 23, 2018 at 02:17:28PM -0700, Randy Dunlap wrote:
>> On 04/23/18 12:53, Greg KH wrote:
>>> On Mon, Apr 23, 2018 at 11:38:18AM -0700, Randy Dunlap wrote:
>>>> On 04/23/18 07:46, Bryant G. Ly wrote:
>>>>> This driver is a logical device which provides an
>>>>> interface between the hypervisor and a management
>>>>> partition.
>>>>>
>>>>> This driver is to be used for the POWER Virtual
>>>>> Management Channel Virtual Adapter on the PowerVM
>>>>> platform. It provides both request/response and
>>>>> async message support through the /dev/ibmvmc node.
>>>>>
>>>>> Signed-off-by: Bryant G. Ly <bryantly@linux.vnet.ibm.com>
>>>>> Reviewed-by: Steven Royer <seroyer@linux.vnet.ibm.com>
>>>>> Reviewed-by: Adam Reznechek <adreznec@linux.vnet.ibm.com>
>>>>> Tested-by: Taylor Jakobson <tjakobs@us.ibm.com>
>>>>> Tested-by: Brad Warrum <bwarrum@us.ibm.com>
>>>>> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
>>>>> Cc: Arnd Bergmann <arnd@arndb.de>
>>>>> Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
>>>>> Cc: Michael Ellerman <mpe@ellerman.id.au>
>>>>> ---
>>>>>  Documentation/ioctl/ioctl-number.txt  |    1 +
>>>>>  Documentation/misc-devices/ibmvmc.txt |  161 +++
>>>>>  MAINTAINERS                           |    6 +
>>>>>  arch/powerpc/include/asm/hvcall.h     |    1 +
>>>>>  drivers/misc/Kconfig                  |   14 +
>>>>>  drivers/misc/Makefile                 |    1 +
>>>>>  drivers/misc/ibmvmc.c                 | 2415 +++++++++++++++++++++++++++++++++
>>>>>  drivers/misc/ibmvmc.h                 |  209 +++
>>>>>  8 files changed, 2808 insertions(+)
>>>>>  create mode 100644 Documentation/misc-devices/ibmvmc.txt
>>>>>  create mode 100644 drivers/misc/ibmvmc.c
>>>>>  create mode 100644 drivers/misc/ibmvmc.h
>>>>
>>>>> diff --git a/Documentation/misc-devices/ibmvmc.txt b/Documentation/misc-devices/ibmvmc.txt
>>>>> new file mode 100644
>>>>> index 0000000..bae1064
>>>>> --- /dev/null
>>>>> +++ b/Documentation/misc-devices/ibmvmc.txt
>>>
>>> Aren't we doing new documentation in .rst format instead of .txt?
>>
>> I am not aware that .rst format is a *requirement* for new documentation.
>>
>> ??
> 
> Why wouldn't you create new documentation in that format?  Just saves
> the step of having to change it again in the future.

Not everything needs to be in that format.
If a document contains graphics or lots of tables, then sure, use RST.

Do you do kernel Documentation builds yourself?  Do you know how slow they are?

-- 
~Randy
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html