linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jani Nikula <jani.nikula@linux.intel.com>
To: Tom Levy <tomlevy93@gmail.com>, Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org,
	Trivial Patch Monkey <trivial@kernel.org>,
	Tom Levy <tomlevy93@gmail.com>
Subject: Re: [PATCH] docs: remove spaces from shell variable assignment
Date: Thu, 21 Mar 2019 15:36:30 +0200	[thread overview]
Message-ID: <87imwce4dd.fsf@intel.com> (raw)
In-Reply-To: <20190321013756.13028-1-tomlevy93@gmail.com>

On Thu, 21 Mar 2019, Tom Levy <tomlevy93@gmail.com> wrote:
> The instructions for generating patches are given as shell commands
> with variables as placeholders. They use the syntax "SRCTREE= linux",
> which is wrong for the Bourne shell family (it runs the command
> "linux" with the variable "SRCTREE" set to the empty string).
>
> Remove the spaces to avoid confusion. This breaks the pretty alignment
> but helps new contributors who try to run the commands as written.

The change looks fine.

Note that new contributors should *never* follow this section anyway. In
fact, I think *nobody* should follow this section...

BR,
Jani.


>
> Signed-off-by: Tom Levy <tomlevy93@gmail.com>
> Cc: Jonathan Corbet <corbet@lwn.net>
> ---
>  Documentation/process/submitting-patches.rst                    | 6 +++---
>  Documentation/translations/it_IT/process/submitting-patches.rst | 6 +++---
>  Documentation/translations/ja_JP/SubmittingPatches              | 6 +++---
>  Documentation/translations/zh_CN/SubmittingPatches              | 6 +++---
>  4 files changed, 12 insertions(+), 12 deletions(-)
>
> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index be7d1829c3af..33098adc5381 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -60,8 +60,8 @@ not in any lower subdirectory.
>  
>  To create a patch for a single file, it is often sufficient to do::
>  
> -	SRCTREE= linux
> -	MYFILE=  drivers/net/mydriver.c
> +	SRCTREE=linux
> +	MYFILE=drivers/net/mydriver.c
>  
>  	cd $SRCTREE
>  	cp $MYFILE $MYFILE.orig
> @@ -73,7 +73,7 @@ To create a patch for multiple files, you should unpack a "vanilla",
>  or unmodified kernel source tree, and generate a ``diff`` against your
>  own source tree.  For example::
>  
> -	MYSRC= /devel/linux
> +	MYSRC=/devel/linux
>  
>  	tar xvfz linux-3.19.tar.gz
>  	mv linux-3.19 linux-3.19-vanilla
> diff --git a/Documentation/translations/it_IT/process/submitting-patches.rst b/Documentation/translations/it_IT/process/submitting-patches.rst
> index 2ab9c1401aa1..713fba075b9d 100644
> --- a/Documentation/translations/it_IT/process/submitting-patches.rst
> +++ b/Documentation/translations/it_IT/process/submitting-patches.rst
> @@ -67,8 +67,8 @@ sulla radice dei sorgenti del kernel, e non sulle sue sottocartelle.
>  
>  Per creare una patch per un singolo file, spesso è sufficiente fare::
>  
> -	SRCTREE= linux
> -	MYFILE=  drivers/net/mydriver.c
> +	SRCTREE=linux
> +	MYFILE=drivers/net/mydriver.c
>  
>  	cd $SRCTREE
>  	cp $MYFILE $MYFILE.orig
> @@ -80,7 +80,7 @@ Per creare una patch per molteplici file, dovreste spacchettare i sorgenti
>  "vergini", o comunque non modificati, e fare un ``diff`` coi vostri.
>  Per esempio::
>  
> -	MYSRC= /devel/linux
> +	MYSRC=/devel/linux
>  
>  	tar xvfz linux-3.19.tar.gz
>  	mv linux-3.19 linux-3.19-vanilla
> diff --git a/Documentation/translations/ja_JP/SubmittingPatches b/Documentation/translations/ja_JP/SubmittingPatches
> index 02139656463e..ad979c3c06a6 100644
> --- a/Documentation/translations/ja_JP/SubmittingPatches
> +++ b/Documentation/translations/ja_JP/SubmittingPatches
> @@ -58,8 +58,8 @@ Linux カーネルに対する全ての変更は diff(1) コマンドによる
>  1個のファイルについてのパッチを作成するためには、ほとんどの場合、
>  以下の作業を行えば十分です。
>  
> -	SRCTREE= linux-2.6
> -	MYFILE=  drivers/net/mydriver.c
> +	SRCTREE=linux-2.6
> +	MYFILE=drivers/net/mydriver.c
>  
>  	cd $SRCTREE
>  	cp $MYFILE $MYFILE.orig
> @@ -71,7 +71,7 @@ Linux カーネルに対する全ての変更は diff(1) コマンドによる
>  なわち変更を加えてない Linux カーネルを展開し、自分の Linux カーネル
>  ソースとの差分を生成しないといけません。例えば、
>  
> -	MYSRC= /devel/linux-2.6
> +	MYSRC=/devel/linux-2.6
>  
>  	tar xvfz linux-2.6.12.tar.gz
>  	mv linux-2.6.12 linux-2.6.12-vanilla
> diff --git a/Documentation/translations/zh_CN/SubmittingPatches b/Documentation/translations/zh_CN/SubmittingPatches
> index e9098da8f1a4..04d9a1f89b58 100644
> --- a/Documentation/translations/zh_CN/SubmittingPatches
> +++ b/Documentation/translations/zh_CN/SubmittingPatches
> @@ -51,8 +51,8 @@ Documentation/process/submitting-drivers.rst 。
>  何子目录。
>  为一个单独的文件创建补丁,一般来说这样做就够了:
>  
> -        SRCTREE= linux-2.6
> -        MYFILE=  drivers/net/mydriver.c
> +        SRCTREE=linux-2.6
> +        MYFILE=drivers/net/mydriver.c
>  
>          cd $SRCTREE
>          cp $MYFILE $MYFILE.orig
> @@ -63,7 +63,7 @@ Documentation/process/submitting-drivers.rst 。
>  为多个文件创建补丁,你可以解开一个没有修改过的内核源代码树,然后和你自
>  己的代码树之间做 diff 。例如:
>  
> -        MYSRC= /devel/linux-2.6
> +        MYSRC=/devel/linux-2.6
>  
>          tar xvfz linux-2.6.12.tar.gz
>          mv linux-2.6.12 linux-2.6.12-vanilla

-- 
Jani Nikula, Intel Open Source Graphics Center

  reply	other threads:[~2019-03-21 13:34 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-21  1:37 [PATCH] docs: remove spaces from shell variable assignment Tom Levy
2019-03-21 13:36 ` Jani Nikula [this message]
2019-03-25 15:53 ` Jonathan Corbet

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=87imwce4dd.fsf@intel.com \
    --to=jani.nikula@linux.intel.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=tomlevy93@gmail.com \
    --cc=trivial@kernel.org \
    /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).