linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Finn Thain <fthain@telegraphics.com.au>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	Michael Schmitz <schmitzmic@gmail.com>,
	"James E.J. Bottomley" <jejb@linux.ibm.com>,
	"Martin K. Petersen" <martin.petersen@oracle.com>,
	linux-scsi@vger.kernel.org
Subject: Re: [PATCH 16/42] docs: scsi: convert g_NCR5380.txt to ReST
Date: Tue, 3 Mar 2020 11:21:27 +1100 (AEDT)	[thread overview]
Message-ID: <alpine.LNX.2.22.394.2003030954230.9@nippy.intranet> (raw)
In-Reply-To: <a66e9ea704be6a7aa81b9864ad66a32b75ab808d.1583136624.git.mchehab+huawei@kernel.org>

On Mon, 2 Mar 2020, Mauro Carvalho Chehab wrote:

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Acked-by: Finn Thain <fthain@telegraphics.com.au>

> ---
>  .../scsi/{g_NCR5380.txt => g_NCR5380.rst}     | 89 ++++++++++++-------
>  Documentation/scsi/index.rst                  |  1 +
>  Documentation/scsi/scsi-parameters.txt        |  6 +-
>  MAINTAINERS                                   |  2 +-
>  drivers/scsi/g_NCR5380.c                      |  2 +-
>  5 files changed, 63 insertions(+), 37 deletions(-)
>  rename Documentation/scsi/{g_NCR5380.txt => g_NCR5380.rst} (41%)
> 
> diff --git a/Documentation/scsi/g_NCR5380.txt b/Documentation/scsi/g_NCR5380.rst
> similarity index 41%
> rename from Documentation/scsi/g_NCR5380.txt
> rename to Documentation/scsi/g_NCR5380.rst
> index 37b1967a00a9..a282059fec43 100644
> --- a/Documentation/scsi/g_NCR5380.txt
> +++ b/Documentation/scsi/g_NCR5380.rst
> @@ -1,7 +1,13 @@
> -README file for the Linux g_NCR5380 driver.
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include:: <isonum.txt>
>  
> -(c) 1993 Drew Eckhard
> -NCR53c400 extensions (c) 1994,1995,1996 Kevin Lentin
> +==========================================
> +README file for the Linux g_NCR5380 driver
> +==========================================
> +
> +Copyright |copy| 1993 Drew Eckhard
> +
> +NCR53c400 extensions Copyright |copy| 1994,1995,1996 Kevin Lentin
>  
>  This file documents the NCR53c400 extensions by Kevin Lentin and some
>  enhancements to the NCR5380 core.
> @@ -26,43 +32,62 @@ time. More info to come in the future.
>  This driver works as a module.
>  When included as a module, parameters can be passed on the insmod/modprobe
>  command line:
> +
> +  ============= ===============================================================
>    irq=xx[,...]	the interrupt(s)
>    base=xx[,...]	the port or base address(es) (for port or memory mapped, resp.)
>    card=xx[,...]	card type(s):
> -		0 = NCR5380,
> -		1 = NCR53C400,
> -		2 = NCR53C400A,
> -		3 = Domex Technology Corp 3181E (DTC3181E)
> -		4 = Hewlett Packard C2502
> +
> +		==  ======================================
> +		0   NCR5380,
> +		1   NCR53C400,
> +		2   NCR53C400A,
> +		3   Domex Technology Corp 3181E (DTC3181E)
> +		4   Hewlett Packard C2502
> +		==  ======================================
> +  ============= ===============================================================
>  
>  These old-style parameters can support only one card:
> -  ncr_irq=xx   the interrupt
> -  ncr_addr=xx  the port or base address (for port or memory
> -               mapped, resp.)
> -  ncr_5380=1   to set up for a NCR5380 board
> -  ncr_53c400=1 to set up for a NCR53C400 board
> +
> +  ============= =================================================
> +  ncr_irq=xx    the interrupt
> +  ncr_addr=xx   the port or base address (for port or memory
> +                mapped, resp.)
> +  ncr_5380=1    to set up for a NCR5380 board
> +  ncr_53c400=1  to set up for a NCR53C400 board
>    ncr_53c400a=1 to set up for a NCR53C400A board
> -  dtc_3181e=1  to set up for a Domex Technology Corp 3181E board
> -  hp_c2502=1   to set up for a Hewlett Packard C2502 board
> -
> -E.g. Trantor T130B in its default configuration:
> -modprobe g_NCR5380 irq=5 base=0x350 card=1
> -or alternatively, using the old syntax,
> -modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
> -
> -E.g. a port mapped NCR5380 board, driver to probe for IRQ:
> -modprobe g_NCR5380 base=0x350 card=0
> -or alternatively,
> -modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
> -
> -E.g. a memory mapped NCR53C400 board with no IRQ:
> -modprobe g_NCR5380 irq=255 base=0xc8000 card=1
> -or alternatively,
> -modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
> +  dtc_3181e=1   to set up for a Domex Technology Corp 3181E board
> +  hp_c2502=1    to set up for a Hewlett Packard C2502 board
> +  ============= =================================================
> +
> +E.g. Trantor T130B in its default configuration::
> +
> +	modprobe g_NCR5380 irq=5 base=0x350 card=1
> +
> +or alternatively, using the old syntax::
> +
> +	modprobe g_NCR5380 ncr_irq=5 ncr_addr=0x350 ncr_53c400=1
> +
> +E.g. a port mapped NCR5380 board, driver to probe for IRQ::
> +
> +	modprobe g_NCR5380 base=0x350 card=0
> +
> +or alternatively::
> +
> +	modprobe g_NCR5380 ncr_addr=0x350 ncr_5380=1
> +
> +E.g. a memory mapped NCR53C400 board with no IRQ::
> +
> +	modprobe g_NCR5380 irq=255 base=0xc8000 card=1
> +
> +or alternatively::
> +
> +	modprobe g_NCR5380 ncr_irq=255 ncr_addr=0xc8000 ncr_53c400=1
>  
>  E.g. two cards, DTC3181 (in non-PnP mode) at 0x240 with no IRQ
> -and HP C2502 at 0x300 with IRQ 7:
> -modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
> +and HP C2502 at 0x300 with IRQ 7::
> +
> +	modprobe g_NCR5380 irq=0,7 base=0x240,0x300 card=3,4
>  
>  Kevin Lentin
>  K.Lentin@cs.monash.edu.au
> diff --git a/Documentation/scsi/index.rst b/Documentation/scsi/index.rst
> index aad8359357e6..4b577c9e804e 100644
> --- a/Documentation/scsi/index.rst
> +++ b/Documentation/scsi/index.rst
> @@ -20,5 +20,6 @@ Linux SCSI Subsystem
>     dc395x
>     dpti
>     FlashPoint
> +   g_NCR5380
>  
>     scsi_transport_srp/figures
> diff --git a/Documentation/scsi/scsi-parameters.txt b/Documentation/scsi/scsi-parameters.txt
> index 266fd3b2398a..864bbf7f737b 100644
> --- a/Documentation/scsi/scsi-parameters.txt
> +++ b/Documentation/scsi/scsi-parameters.txt
> @@ -57,13 +57,13 @@ parameters may be changed at runtime by the command
>  			See header of drivers/scsi/NCR_D700.c.
>  
>  	ncr5380=	[HW,SCSI]
> -			See Documentation/scsi/g_NCR5380.txt.
> +			See Documentation/scsi/g_NCR5380.rst.
>  
>  	ncr53c400=	[HW,SCSI]
> -			See Documentation/scsi/g_NCR5380.txt.
> +			See Documentation/scsi/g_NCR5380.rst.
>  
>  	ncr53c400a=	[HW,SCSI]
> -			See Documentation/scsi/g_NCR5380.txt.
> +			See Documentation/scsi/g_NCR5380.rst.
>  
>  	ncr53c8xx=	[HW,SCSI]
>  
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 1e2ab816fe66..451a3f67d23a 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -11533,7 +11533,7 @@ M:	Finn Thain <fthain@telegraphics.com.au>
>  M:	Michael Schmitz <schmitzmic@gmail.com>
>  L:	linux-scsi@vger.kernel.org
>  S:	Maintained
> -F:	Documentation/scsi/g_NCR5380.txt
> +F:	Documentation/scsi/g_NCR5380.rst
>  F:	drivers/scsi/NCR5380.*
>  F:	drivers/scsi/arm/cumana_1.c
>  F:	drivers/scsi/arm/oak.c
> diff --git a/drivers/scsi/g_NCR5380.c b/drivers/scsi/g_NCR5380.c
> index 2ab774e62e40..2cc676e3df6a 100644
> --- a/drivers/scsi/g_NCR5380.c
> +++ b/drivers/scsi/g_NCR5380.c
> @@ -20,7 +20,7 @@
>   * Added ISAPNP support for DTC436 adapters,
>   * Thomas Sailer, sailer@ife.ee.ethz.ch
>   *
> - * See Documentation/scsi/g_NCR5380.txt for more info.
> + * See Documentation/scsi/g_NCR5380.rst for more info.
>   */
>  
>  #include <asm/io.h>
> 

  reply	other threads:[~2020-03-03  0:21 UTC|newest]

Thread overview: 55+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-03-02  8:15 [PATCH 00/42] Manually convert SCSI documentation to ReST format Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 01/42] Add an empty index file for SCSI documents Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 02/42] docs: scsi: include SCSI Transport SRP diagram at the doc body Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 03/42] docs: scsi: convert 53c700.txt to ReST Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 04/42] docs: scsi: convert aacraid.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 05/42] docs: scsi: convert advansys.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 06/42] docs: scsi: convert aha152x.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 07/42] docs: scsi: convert aic79xx.txt " Mauro Carvalho Chehab
2020-03-17 13:41   ` Christoph Hellwig
2020-03-02  8:15 ` [PATCH 08/42] docs: scsi: convert aic7xxx.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 09/42] docs: scsi: convert bfa.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 10/42] docs: scsi: convert bnx2fc.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 11/42] docs: scsi: convert BusLogic.txt " Mauro Carvalho Chehab
2020-03-04 18:58   ` Khalid Aziz
2020-03-02  8:15 ` [PATCH 12/42] docs: scsi: convert cxgb3i.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 13/42] docs: scsi: convert dc395x.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 14/42] docs: scsi: convert dpti.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 15/42] docs: scsi: convert FlashPoint.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 16/42] docs: scsi: convert g_NCR5380.txt " Mauro Carvalho Chehab
2020-03-03  0:21   ` Finn Thain [this message]
2020-03-02  8:15 ` [PATCH 17/42] docs: scsi: convert hpsa.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 18/42] docs: scsi: convert hptiop.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 19/42] docs: scsi: convert libsas.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 20/42] docs: scsi: convert link_power_management_policy.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 21/42] docs: scsi: convert lpfc.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 22/42] docs: scsi: convert megaraid.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 24/42] docs: scsi: convert NinjaSCSI.txt " Mauro Carvalho Chehab
2020-03-11 13:06   ` Masanori Goto
2020-03-02  8:15 ` [PATCH 25/42] docs: scsi: convert ppa.txt " Mauro Carvalho Chehab
2020-03-02  8:15 ` [PATCH 26/42] docs: scsi: convert qlogicfas.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 27/42] docs: scsi: convert scsi-changer.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 28/42] docs: scsi: convert scsi_eh.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 29/42] docs: scsi: convert scsi_fc_transport.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 30/42] docs: scsi: convert scsi-generic.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 31/42] docs: scsi: convert scsi_mid_low_api.txt " Mauro Carvalho Chehab
2020-03-03  0:20   ` Finn Thain
2020-03-17 13:44   ` Christoph Hellwig
2020-03-02  8:16 ` [PATCH 32/42] docs: scsi: convert scsi-parameters.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 33/42] docs: scsi: convert scsi.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 34/42] docs: scsi: convert sd-parameters.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 35/42] docs: scsi: convert smartpqi.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 36/42] docs: scsi: convert st.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 37/42] docs: scsi: convert sym53c500_cs.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 38/42] docs: scsi: convert sym53c8xx_2.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 39/42] docs: scsi: convert tcm_qla2xxx.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 40/42] docs: scsi: convert ufs.txt " Mauro Carvalho Chehab
2020-03-03  7:22   ` Avri Altman
2020-03-02  8:16 ` [PATCH 41/42] docs: scsi: convert wd719x.txt " Mauro Carvalho Chehab
2020-03-02  8:16 ` [PATCH 42/42] docs: scsi: convert arcmsr_spec.txt " Mauro Carvalho Chehab
2020-03-10 17:43 ` [PATCH 00/42] Manually convert SCSI documentation to ReST format Jonathan Corbet
2020-03-10 17:50   ` Martin K. Petersen
2020-03-10 17:58     ` Jonathan Corbet
2020-03-10 23:40 ` Martin K. Petersen
2020-03-11 11:50   ` Mauro Carvalho Chehab
2020-03-12  3:05     ` Martin K. Petersen

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=alpine.LNX.2.22.394.2003030954230.9@nippy.intranet \
    --to=fthain@telegraphics.com.au \
    --cc=corbet@lwn.net \
    --cc=jejb@linux.ibm.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-scsi@vger.kernel.org \
    --cc=martin.petersen@oracle.com \
    --cc=mchehab+huawei@kernel.org \
    --cc=schmitzmic@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).