docs: remove spaces from shell variable assignment
Subsystems (5)
PATCH 1/1 docs: remove spaces from shell variable assignment
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.
--- 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(-)
Documentation/process/submitting-patches.rst +3 -3
@@ -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
Documentation/translations/it_IT/process/submitting-patches.rst +3 -3
@@ -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
Documentation/translations/ja_JP/SubmittingPatches +3 -3
@@ -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
Documentation/translations/zh_CN/SubmittingPatches +3 -3
@@ -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
Signature · 1 line
2.11.0
Quoted 7 lines · Tom Levy
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.
Quoted 106 lines
Signed-off-by Tom Levy <[email protected]>Cc Jonathan Corbet <[email protected]>--- 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(-)Documentation/process/submitting-patches.rst +3
-3@@ -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-vanillaDocumentation/translations/it_IT/process/submitting-patches.rst +3
-3@@ -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-vanillaDocumentation/translations/ja_JP/SubmittingPatches +3
-3@@ -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-vanillaDocumentation/translations/zh_CN/SubmittingPatches +3
-3@@ -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
Signature · 1 line
Jani Nikula, Intel Open Source Graphics Center
Quoted 10 lines · On Thu, 21 Mar 2019 14:37:56 +1300 Tom Levy <[email protected]> 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.
Signed-off-by Tom Levy <[email protected]>Cc Jonathan Corbet <[email protected]>
Applied, thanks. Though I agree with Jani that this advice is looking a little dated in general...
jon