Re: [PATCH 8/8] staging: fsl-mc: Convert documentation to rst format

2018-01-16 Thread Greg KH 
On Tue, Jan 16, 2018 at 03:40:18PM +, Ruxandra Ioana Ciocoi Radulescu wrote:
> > -Original Message-
> > From: Greg KH [mailto:gre...@linuxfoundation.org]
> > Sent: Tuesday, January 16, 2018 5:14 PM
> > To: Bogdan Purcareata <bogdan.purcare...@nxp.com>
> > Cc: Laurentiu Tudor <laurentiu.tu...@nxp.com>; Ruxandra Ioana Ciocoi
> > Radulescu <ruxandra.radule...@nxp.com>; de...@driverdev.osuosl.org;
> > r...@kernel.org; stuyo...@gmail.com; a...@arndb.de;
> > marc.zyng...@arm.com; Roy Pledge <roy.ple...@nxp.com>; Ioana Ciornei
> > <ioana.cior...@nxp.com>; linux-ker...@vger.kernel.org; Horia Geantă
> > <horia.gea...@nxp.com>; Nipun Gupta <nipun.gu...@nxp.com>;
> > t...@linutronix.de; linux-arm-ker...@lists.infradead.org;
> > ja...@lakedaemon.net
> > Subject: Re: [PATCH 8/8] staging: fsl-mc: Convert documentation to rst
> > format
> > 
> > On Tue, Jan 16, 2018 at 03:19:10PM +0200, Bogdan Purcareata wrote:
> > > From: Ioana Radulescu <ruxandra.radule...@nxp.com>
> > >
> > > Update the doc file to comply with the rst format.
> > >
> > > It's not integrated into the documentation build structure yet,
> > > since it's still located in drivers/staging.
> > >
> > > Signed-off-by: Ioana Radulescu <ruxandra.radule...@nxp.com>
> > > Reviewed-by: Laurentiu Tudor <laurentiu.tu...@nxp.com>
> > > ---
> > >  drivers/staging/fsl-mc/README.txt   | 387 
> > > --
> > >  drivers/staging/fsl-mc/overview.rst | 404
> > 
> > >  2 files changed, 404 insertions(+), 387 deletions(-)
> > >  delete mode 100644 drivers/staging/fsl-mc/README.txt
> > >  create mode 100644 drivers/staging/fsl-mc/overview.rst
> > 
> > Please generate patches with the -M option to git format-patch, so we
> > can see the file move, not just get removed and added as a brand new
> > one.
> 
> Sure, I can do this.
> 
> Even with -M, the diff is rather large since the indenting changes for most
> of the lines in the file. Would it be better to make two patches, with
> the first changing just line indenting and the second one, where the file is
> moved, only updating rst specific markups?

Nah, just use -M and we can take it from there.

thanks,

greg k-h
___
devel mailing list
de...@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

RE: [PATCH 8/8] staging: fsl-mc: Convert documentation to rst format

2018-01-16 Thread Ruxandra Ioana Ciocoi Radulescu 
> -Original Message-
> From: Greg KH [mailto:gre...@linuxfoundation.org]
> Sent: Tuesday, January 16, 2018 5:14 PM
> To: Bogdan Purcareata <bogdan.purcare...@nxp.com>
> Cc: Laurentiu Tudor <laurentiu.tu...@nxp.com>; Ruxandra Ioana Ciocoi
> Radulescu <ruxandra.radule...@nxp.com>; de...@driverdev.osuosl.org;
> r...@kernel.org; stuyo...@gmail.com; a...@arndb.de;
> marc.zyng...@arm.com; Roy Pledge <roy.ple...@nxp.com>; Ioana Ciornei
> <ioana.cior...@nxp.com>; linux-ker...@vger.kernel.org; Horia Geantă
> <horia.gea...@nxp.com>; Nipun Gupta <nipun.gu...@nxp.com>;
> t...@linutronix.de; linux-arm-ker...@lists.infradead.org;
> ja...@lakedaemon.net
> Subject: Re: [PATCH 8/8] staging: fsl-mc: Convert documentation to rst
> format
> 
> On Tue, Jan 16, 2018 at 03:19:10PM +0200, Bogdan Purcareata wrote:
> > From: Ioana Radulescu <ruxandra.radule...@nxp.com>
> >
> > Update the doc file to comply with the rst format.
> >
> > It's not integrated into the documentation build structure yet,
> > since it's still located in drivers/staging.
> >
> > Signed-off-by: Ioana Radulescu <ruxandra.radule...@nxp.com>
> > Reviewed-by: Laurentiu Tudor <laurentiu.tu...@nxp.com>
> > ---
> >  drivers/staging/fsl-mc/README.txt   | 387 
> > --
> >  drivers/staging/fsl-mc/overview.rst | 404
> 
> >  2 files changed, 404 insertions(+), 387 deletions(-)
> >  delete mode 100644 drivers/staging/fsl-mc/README.txt
> >  create mode 100644 drivers/staging/fsl-mc/overview.rst
> 
> Please generate patches with the -M option to git format-patch, so we
> can see the file move, not just get removed and added as a brand new
> one.

Sure, I can do this.

Even with -M, the diff is rather large since the indenting changes for most
of the lines in the file. Would it be better to make two patches, with
the first changing just line indenting and the second one, where the file is
moved, only updating rst specific markups?

Thanks,
Ioana
___
devel mailing list
de...@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

Re: [PATCH 8/8] staging: fsl-mc: Convert documentation to rst format

2018-01-16 Thread Greg KH 
On Tue, Jan 16, 2018 at 03:19:10PM +0200, Bogdan Purcareata wrote:
> From: Ioana Radulescu 
> 
> Update the doc file to comply with the rst format.
> 
> It's not integrated into the documentation build structure yet,
> since it's still located in drivers/staging.
> 
> Signed-off-by: Ioana Radulescu 
> Reviewed-by: Laurentiu Tudor 
> ---
>  drivers/staging/fsl-mc/README.txt   | 387 --
>  drivers/staging/fsl-mc/overview.rst | 404 
> 
>  2 files changed, 404 insertions(+), 387 deletions(-)
>  delete mode 100644 drivers/staging/fsl-mc/README.txt
>  create mode 100644 drivers/staging/fsl-mc/overview.rst

Please generate patches with the -M option to git format-patch, so we
can see the file move, not just get removed and added as a brand new
one.

thanks,

greg k-h
___
devel mailing list
de...@linuxdriverproject.org
http://driverdev.linuxdriverproject.org/mailman/listinfo/driverdev-devel

[PATCH 8/8] staging: fsl-mc: Convert documentation to rst format

2018-01-16 Thread Bogdan Purcareata 
From: Ioana Radulescu 

Update the doc file to comply with the rst format.

It's not integrated into the documentation build structure yet,
since it's still located in drivers/staging.

Signed-off-by: Ioana Radulescu 
Reviewed-by: Laurentiu Tudor 
---
 drivers/staging/fsl-mc/README.txt   | 387 --
 drivers/staging/fsl-mc/overview.rst | 404 
 2 files changed, 404 insertions(+), 387 deletions(-)
 delete mode 100644 drivers/staging/fsl-mc/README.txt
 create mode 100644 drivers/staging/fsl-mc/overview.rst

diff --git a/drivers/staging/fsl-mc/README.txt 
b/drivers/staging/fsl-mc/README.txt
deleted file mode 100644
index 0ea5cd7..000
--- a/drivers/staging/fsl-mc/README.txt
+++ /dev/null
@@ -1,387 +0,0 @@
-Copyright (C) 2015 Freescale Semiconductor Inc.
-
-DPAA2 (Data Path Acceleration Architecture Gen2) Overview
--
-
-This document provides an overview of the Freescale DPAA2 architecture
-and how it is integrated into the Linux kernel.
-
-Contents summary
-   -DPAA2 overview
-   -Overview of DPAA2 objects
-   -DPAA2 Linux driver architecture overview
--bus driver
--DPRC driver
--allocator
--DPIO driver
--Ethernet
--MAC
-
-Introduction
-
-
-DPAA2 is a hardware architecture designed for high-speeed network
-packet processing.  DPAA2 consists of sophisticated mechanisms for
-processing Ethernet packets, queue management, buffer management,
-autonomous L2 switching, virtual Ethernet bridging, and accelerator
-(e.g. crypto) sharing.
-
-A DPAA2 hardware component called the Management Complex (or MC) manages the
-DPAA2 hardware resources.  The MC provides an object-based abstraction for
-software drivers to use the DPAA2 hardware.
-
-The MC uses DPAA2 hardware resources such as queues, buffer pools, and
-network ports to create functional objects/devices such as network
-interfaces, an L2 switch, or accelerator instances.
-
-The MC provides memory-mapped I/O command interfaces (MC portals)
-which DPAA2 software drivers use to operate on DPAA2 objects.
-
-The diagram below shows an overview of the DPAA2 resource management
-architecture:
-
- +--+
- |  OS  |
- |DPAA2 drivers |
- | ||
- +-|+
-   |
-   | (create,discover,connect
-   |  config,use,destroy)
-   |
- DPAA2 |
- +| mc portal |-+
- | ||
- |   +- - - - - - - - - - - - -V- - -+  |
- |   |   |  |
- |   |   Management Complex (MC) |  |
- |   |   |  |
- |   +- - - - - - - - - - - - - - - -+  |
- |  |
- | Hardware  Hardware   |
- | Resources Objects|
- | - ---|
- | -queues   -DPRC  |
- | -buffer pools -DPMCP |
- | -Eth MACs/ports   -DPIO  |
- | -network interface-DPNI  |
- |  profiles -DPMAC |
- | -queue portals-DPBP  |
- | -MC portals...   |
- |  ... |
- |  |
- +--+
-
-The MC mediates operations such as create, discover,
-connect, configuration, and destroy.  Fast-path operations
-on data, such as packet transmit/receive, are not mediated by
-the MC and are done directly using memory mapped regions in
-DPIO objects.
-
-Overview of DPAA2 Objects
--
-The section provides a brief overview of some key DPAA2 objects.
-A simple scenario is described illustrating the objects involved
-in creating a network interfaces.
-
--DPRC (Datapath Resource Container)
-
-A DPRC is a container object that holds all the other
-types of DPAA2 objects.  In the example diagram below there
-are 8 objects of 5 types (DPMCP, DPIO, DPBP, DPNI, and DPMAC)
-in the container.
-
-+-+
-| DPRC|
-| |
-|  +---+  +---+  +---+  +---+  +---+  |
-|  | DPMCP |  | DPIO  |  | DPBP  |  | DPNI  |  | DPMAC |  |
-|  +---+