diff mbox series

[1/4] docs: bpf: Rename README.rst to index.rst

Message ID 20180725022926.8993-2-me@tobin.cc
State Superseded, archived
Delegated to: BPF Maintainers
Headers show
Series docs: bpf: Fix RST conversion | expand

Commit Message

Tobin C. Harding July 25, 2018, 2:29 a.m. UTC
Recently bpf/ docs were converted to us RST format.  'README.rst' was
created but in order to fit in with the Sphinx build system this file
should be named 'index.rst'.  Rename file, fixes to integrate into Sphinx
build system in following patches.

docs: Rename Documentation/bpf/README.rst to Documentation/bpf/index.rst

Signed-off-by: Tobin C. Harding <me@tobin.cc>
---
 Documentation/bpf/{README.rst => index.rst} | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename Documentation/bpf/{README.rst => index.rst} (100%)

Comments

Sergei Shtylyov July 25, 2018, 9:29 a.m. UTC | #1
Hello!

On 7/25/2018 5:29 AM, Tobin C. Harding wrote:

> Recently bpf/ docs were converted to us RST format.  'README.rst' was

    s/us/use/?

> created but in order to fit in with the Sphinx build system this file
> should be named 'index.rst'.  Rename file, fixes to integrate into Sphinx
> build system in following patches.
> 
> docs: Rename Documentation/bpf/README.rst to Documentation/bpf/index.rst
> 
> Signed-off-by: Tobin C. Harding <me@tobin.cc>
[...]

MBR, Sergei
Tobin C. Harding July 25, 2018, 10:28 p.m. UTC | #2
On Wed, Jul 25, 2018 at 12:29:10PM +0300, Sergei Shtylyov wrote:
> Hello!
> 
> On 7/25/2018 5:29 AM, Tobin C. Harding wrote:
> 
> > Recently bpf/ docs were converted to us RST format.  'README.rst' was
> 
>    s/us/use/?

Thanks for the review Sergei, will fix and re-spin.

> > created but in order to fit in with the Sphinx build system this file
> > should be named 'index.rst'.  Rename file, fixes to integrate into Sphinx
> > build system in following patches.
> > 
> > docs: Rename Documentation/bpf/README.rst to Documentation/bpf/index.rst
> > 
> > Signed-off-by: Tobin C. Harding <me@tobin.cc>
> [...]
> 
> MBR, Sergei

What does MBR stand for please (not master boot record I'm guessing)?


	Tobin
Sergei Shtylyov July 26, 2018, 7:48 a.m. UTC | #3
On 7/26/2018 1:28 AM, Tobin C. Harding wrote:

>>> Recently bpf/ docs were converted to us RST format.  'README.rst' was
>>
>>     s/us/use/?
> 
> Thanks for the review Sergei, will fix and re-spin.

    Perhaps could be fixed while applying...

>>> created but in order to fit in with the Sphinx build system this file
>>> should be named 'index.rst'.  Rename file, fixes to integrate into Sphinx
>>> build system in following patches.
>>>
>>> docs: Rename Documentation/bpf/README.rst to Documentation/bpf/index.rst
>>>
>>> Signed-off-by: Tobin C. Harding <me@tobin.cc>
>> [...]
>>
>> MBR, Sergei
> 
> What does MBR stand for please (not master boot record I'm guessing)?

    My best regards. :-)

> 	Tobin

MBR, Sergei
diff mbox series

Patch

diff --git a/Documentation/bpf/README.rst b/Documentation/bpf/index.rst
similarity index 100%
rename from Documentation/bpf/README.rst
rename to Documentation/bpf/index.rst