Re: [PATCH v4 19/28] docs: powerpc: convert docs to ReST and rename to *.rst
Jonathan Corbet writes: > On Wed, 12 Jun 2019 14:52:55 -0300 > Mauro Carvalho Chehab wrote: > >> Convert docs to ReST and add them to the arch-specific >> book. >> >> The conversion here was trivial, as almost every file there >> was already using an elegant format close to ReST standard. >> >> The changes were mostly to mark literal blocks and add a few >> missing section title identifiers. >> >> One note with regards to "--": on Sphinx, this can't be used >> to identify a list, as it will format it badly. This can be >> used, however, to identify a long hyphen - and "---" is an >> even longer one. >> >> At its new index.rst, let's add a :orphan: while this is not linked to >> the main index.rst file, in order to avoid build warnings. >> >> Signed-off-by: Mauro Carvalho Chehab >> Acked-by: Andrew Donnellan # cxl > > This one fails to apply because ... > > [...] > >> diff --git a/Documentation/PCI/pci-error-recovery.rst >> b/Documentation/PCI/pci-error-recovery.rst >> index 83db42092935..acc21ecca322 100644 >> --- a/Documentation/PCI/pci-error-recovery.rst >> +++ b/Documentation/PCI/pci-error-recovery.rst >> @@ -422,3 +422,24 @@ That is, the recovery API only requires that: >> - drivers/net/cxgb3 >> - drivers/net/s2io.c >> - drivers/net/qlge >> + >> +>>> As of this writing, there is a growing list of device drivers with >> +>>> patches implementing error recovery. Not all of these patches are in >> +>>> mainline yet. These may be used as "examples": >> +>>> >> +>>> drivers/scsi/ipr >> +>>> drivers/scsi/sym53c8xx_2 >> +>>> drivers/scsi/qla2xxx >> +>>> drivers/scsi/lpfc >> +>>> drivers/next/bnx2.c >> +>>> drivers/next/e100.c >> +>>> drivers/net/e1000 >> +>>> drivers/net/e1000e >> +>>> drivers/net/ixgb >> +>>> drivers/net/ixgbe >> +>>> drivers/net/cxgb3 >> +>>> drivers/net/s2io.c >> +>>> drivers/net/qlge > > ...of this, which has the look of a set of conflict markers that managed > to get committed...? I don't think so. There's some other uses of >>> in that file, eg about line 162: >>> The current powerpc implementation assumes that a device driver will >>> *not* schedule or semaphore in this routine; the current powerpc >>> implementation uses one kernel thread to notify all devices; >>> thus, if one device sleeps/schedules, all devices are affected. >>> Doing better requires complex multi-threaded logic in the error >>> recovery implementation (e.g. waiting for all notification threads >>> to "join" before proceeding with recovery.) This seems excessively >>> complex and not worth implementing. So it's just an odd choice of emphasis device I think. cheers
Re: [PATCH v4 19/28] docs: powerpc: convert docs to ReST and rename to *.rst
On Fri, Jun 14, 2019 at 02:36:35PM -0600, Jonathan Corbet wrote: > On Wed, 12 Jun 2019 14:52:55 -0300 > Mauro Carvalho Chehab wrote: > > > Convert docs to ReST and add them to the arch-specific > > book. > > > > The conversion here was trivial, as almost every file there > > was already using an elegant format close to ReST standard. > > > > The changes were mostly to mark literal blocks and add a few > > missing section title identifiers. > > > > One note with regards to "--": on Sphinx, this can't be used > > to identify a list, as it will format it badly. This can be > > used, however, to identify a long hyphen - and "---" is an > > even longer one. > > > > At its new index.rst, let's add a :orphan: while this is not linked to > > the main index.rst file, in order to avoid build warnings. > > > > Signed-off-by: Mauro Carvalho Chehab > > Acked-by: Andrew Donnellan # cxl > > This one fails to apply because ... > > [...] > > > diff --git a/Documentation/PCI/pci-error-recovery.rst > > b/Documentation/PCI/pci-error-recovery.rst > > index 83db42092935..acc21ecca322 100644 > > --- a/Documentation/PCI/pci-error-recovery.rst > > +++ b/Documentation/PCI/pci-error-recovery.rst > > @@ -403,7 +403,7 @@ That is, the recovery API only requires that: > > .. note:: > > > > Implementation details for the powerpc platform are discussed in > > - the file Documentation/powerpc/eeh-pci-error-recovery.txt > > + the file Documentation/powerpc/eeh-pci-error-recovery.rst > > > > As of this writing, there is a growing list of device drivers with > > patches implementing error recovery. Not all of these patches are in > > @@ -422,3 +422,24 @@ That is, the recovery API only requires that: > > - drivers/net/cxgb3 > > - drivers/net/s2io.c > > - drivers/net/qlge > > + > > +>>> As of this writing, there is a growing list of device drivers with > > +>>> patches implementing error recovery. Not all of these patches are in > > +>>> mainline yet. These may be used as "examples": > > +>>> > > +>>> drivers/scsi/ipr > > +>>> drivers/scsi/sym53c8xx_2 > > +>>> drivers/scsi/qla2xxx > > +>>> drivers/scsi/lpfc > > +>>> drivers/next/bnx2.c > > +>>> drivers/next/e100.c > > +>>> drivers/net/e1000 > > +>>> drivers/net/e1000e > > +>>> drivers/net/ixgb > > +>>> drivers/net/ixgbe > > +>>> drivers/net/cxgb3 > > +>>> drivers/net/s2io.c > > +>>> drivers/net/qlge > > ...of this, which has the look of a set of conflict markers that managed > to get committed...? I don't see these conflict markers in my local branch or in linux-next (next-20190614). Let me know if I need to do something. Bjorn
Re: [PATCH v4 19/28] docs: powerpc: convert docs to ReST and rename to *.rst
On Wed, 12 Jun 2019 14:52:55 -0300 Mauro Carvalho Chehab wrote: > Convert docs to ReST and add them to the arch-specific > book. > > The conversion here was trivial, as almost every file there > was already using an elegant format close to ReST standard. > > The changes were mostly to mark literal blocks and add a few > missing section title identifiers. > > One note with regards to "--": on Sphinx, this can't be used > to identify a list, as it will format it badly. This can be > used, however, to identify a long hyphen - and "---" is an > even longer one. > > At its new index.rst, let's add a :orphan: while this is not linked to > the main index.rst file, in order to avoid build warnings. > > Signed-off-by: Mauro Carvalho Chehab > Acked-by: Andrew Donnellan # cxl This one fails to apply because ... [...] > diff --git a/Documentation/PCI/pci-error-recovery.rst > b/Documentation/PCI/pci-error-recovery.rst > index 83db42092935..acc21ecca322 100644 > --- a/Documentation/PCI/pci-error-recovery.rst > +++ b/Documentation/PCI/pci-error-recovery.rst > @@ -403,7 +403,7 @@ That is, the recovery API only requires that: > .. note:: > > Implementation details for the powerpc platform are discussed in > - the file Documentation/powerpc/eeh-pci-error-recovery.txt > + the file Documentation/powerpc/eeh-pci-error-recovery.rst > > As of this writing, there is a growing list of device drivers with > patches implementing error recovery. Not all of these patches are in > @@ -422,3 +422,24 @@ That is, the recovery API only requires that: > - drivers/net/cxgb3 > - drivers/net/s2io.c > - drivers/net/qlge > + > +>>> As of this writing, there is a growing list of device drivers with > +>>> patches implementing error recovery. Not all of these patches are in > +>>> mainline yet. These may be used as "examples": > +>>> > +>>> drivers/scsi/ipr > +>>> drivers/scsi/sym53c8xx_2 > +>>> drivers/scsi/qla2xxx > +>>> drivers/scsi/lpfc > +>>> drivers/next/bnx2.c > +>>> drivers/next/e100.c > +>>> drivers/net/e1000 > +>>> drivers/net/e1000e > +>>> drivers/net/ixgb > +>>> drivers/net/ixgbe > +>>> drivers/net/cxgb3 > +>>> drivers/net/s2io.c > +>>> drivers/net/qlge ...of this, which has the look of a set of conflict markers that managed to get committed...? jon
[PATCH v4 19/28] docs: powerpc: convert docs to ReST and rename to *.rst
Convert docs to ReST and add them to the arch-specific book. The conversion here was trivial, as almost every file there was already using an elegant format close to ReST standard. The changes were mostly to mark literal blocks and add a few missing section title identifiers. One note with regards to "--": on Sphinx, this can't be used to identify a list, as it will format it badly. This can be used, however, to identify a long hyphen - and "---" is an even longer one. At its new index.rst, let's add a :orphan: while this is not linked to the main index.rst file, in order to avoid build warnings. Signed-off-by: Mauro Carvalho Chehab Acked-by: Andrew Donnellan # cxl --- Documentation/PCI/pci-error-recovery.rst | 23 ++- .../{bootwrapper.txt => bootwrapper.rst} | 28 +++- .../{cpu_families.txt => cpu_families.rst}| 23 +-- .../{cpu_features.txt => cpu_features.rst}| 6 +- Documentation/powerpc/{cxl.txt => cxl.rst}| 46 -- .../powerpc/{cxlflash.txt => cxlflash.rst}| 10 +- .../{DAWR-POWER9.txt => dawr-power9.rst} | 15 +- Documentation/powerpc/{dscr.txt => dscr.rst} | 18 +- ...ecovery.txt => eeh-pci-error-recovery.rst} | 108 ++-- ...ed-dump.txt => firmware-assisted-dump.rst} | 117 +++-- Documentation/powerpc/{hvcs.txt => hvcs.rst} | 108 ++-- Documentation/powerpc/index.rst | 34 Documentation/powerpc/isa-versions.rst| 15 +- .../powerpc/{mpc52xx.txt => mpc52xx.rst} | 12 +- ...nv.txt => pci_iov_resource_on_powernv.rst} | 15 +- .../powerpc/{pmu-ebb.txt => pmu-ebb.rst} | 1 + Documentation/powerpc/ptrace.rst | 156 ++ Documentation/powerpc/ptrace.txt | 151 - .../{qe_firmware.txt => qe_firmware.rst} | 37 +++-- .../{syscall64-abi.txt => syscall64-abi.rst} | 29 ++-- ...al_memory.txt => transactional_memory.rst} | 45 ++--- MAINTAINERS | 6 +- arch/powerpc/kernel/exceptions-64s.S | 2 +- drivers/soc/fsl/qe/qe.c | 2 +- drivers/tty/hvc/hvcs.c| 2 +- include/soc/fsl/qe/qe.h | 2 +- 26 files changed, 584 insertions(+), 427 deletions(-) rename Documentation/powerpc/{bootwrapper.txt => bootwrapper.rst} (93%) rename Documentation/powerpc/{cpu_families.txt => cpu_families.rst} (95%) rename Documentation/powerpc/{cpu_features.txt => cpu_features.rst} (97%) rename Documentation/powerpc/{cxl.txt => cxl.rst} (95%) rename Documentation/powerpc/{cxlflash.txt => cxlflash.rst} (98%) rename Documentation/powerpc/{DAWR-POWER9.txt => dawr-power9.rst} (95%) rename Documentation/powerpc/{dscr.txt => dscr.rst} (91%) rename Documentation/powerpc/{eeh-pci-error-recovery.txt => eeh-pci-error-recovery.rst} (82%) rename Documentation/powerpc/{firmware-assisted-dump.txt => firmware-assisted-dump.rst} (80%) rename Documentation/powerpc/{hvcs.txt => hvcs.rst} (91%) create mode 100644 Documentation/powerpc/index.rst rename Documentation/powerpc/{mpc52xx.txt => mpc52xx.rst} (91%) rename Documentation/powerpc/{pci_iov_resource_on_powernv.txt => pci_iov_resource_on_powernv.rst} (97%) rename Documentation/powerpc/{pmu-ebb.txt => pmu-ebb.rst} (99%) create mode 100644 Documentation/powerpc/ptrace.rst delete mode 100644 Documentation/powerpc/ptrace.txt rename Documentation/powerpc/{qe_firmware.txt => qe_firmware.rst} (95%) rename Documentation/powerpc/{syscall64-abi.txt => syscall64-abi.rst} (82%) rename Documentation/powerpc/{transactional_memory.txt => transactional_memory.rst} (93%) diff --git a/Documentation/PCI/pci-error-recovery.rst b/Documentation/PCI/pci-error-recovery.rst index 83db42092935..acc21ecca322 100644 --- a/Documentation/PCI/pci-error-recovery.rst +++ b/Documentation/PCI/pci-error-recovery.rst @@ -403,7 +403,7 @@ That is, the recovery API only requires that: .. note:: Implementation details for the powerpc platform are discussed in - the file Documentation/powerpc/eeh-pci-error-recovery.txt + the file Documentation/powerpc/eeh-pci-error-recovery.rst As of this writing, there is a growing list of device drivers with patches implementing error recovery. Not all of these patches are in @@ -422,3 +422,24 @@ That is, the recovery API only requires that: - drivers/net/cxgb3 - drivers/net/s2io.c - drivers/net/qlge + +>>> As of this writing, there is a growing list of device drivers with +>>> patches implementing error recovery. Not all of these patches are in +>>> mainline yet. These may be used as "examples": +>>> +>>> drivers/scsi/ipr +>>> drivers/scsi/sym53c8xx_2 +>>> drivers/scsi/qla2xxx +>>> drivers/scsi/lpfc +>>> drivers/next/bnx2.c +>>> drivers/next/e100.c +>>> drivers/net/e1000 +>>> drivers/net/e1000e +>>> drivers/net/ixgb +>>> drivers/net/ixgbe +>>> drivers/net/cxgb3 +>>> drivers/net/s2io.c +>>> drivers/net/qlge + +The End +--- diff --git