Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1555968 > unrolled thread

[PATCH] docs: Make CodingStyle and SubmittingPatches symlinks

Back to article view | Back to linux.kernel

Contents

  [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Joe Perches <joe@perches.com> - 2017-01-10 23:20 +0100
    Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Jani Nikula <jani.nikula@linux.intel.com> - 2017-01-11 10:00 +0100
      Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Joe Perches <joe@perches.com> - 2017-01-11 10:40 +0100
        Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Jani Nikula <jani.nikula@linux.intel.com> - 2017-01-11 10:50 +0100
    Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Jonathan Corbet <corbet@lwn.net> - 2017-01-13 20:50 +0100
      Re: [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks Joe Perches <joe@perches.com> - 2017-01-13 21:10 +0100

#1555968 — [PATCH] docs: Make CodingStyle and SubmittingPatches symlinks

Make these files symlinks to the .rst equivalents

Signed-off-by: Joe Perches <joe@perches.com>
---
 Documentation/CodingStyle       | 2 +-
 Documentation/SubmittingPatches | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
 mode change 100644 => 120000 Documentation/CodingStyle
 mode change 100644 => 120000 Documentation/SubmittingPatches

diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
deleted file mode 100644
index 320983ca114e..000000000000
--- a/Documentation/CodingStyle
+++ /dev/null
@@ -1 +0,0 @@
-This file has moved to process/coding-style.rst
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
new file mode 120000
index 000000000000..5aacf7ea935a
--- /dev/null
+++ b/Documentation/CodingStyle
@@ -0,0 +1 @@
+./process/coding-style.rst
\ No newline at end of file
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
deleted file mode 100644
index 81455705e4a6..000000000000
--- a/Documentation/SubmittingPatches
+++ /dev/null
@@ -1 +0,0 @@
-This file has moved to process/submitting-patches.rst
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
new file mode 120000
index 000000000000..5ca6e8ba3682
--- /dev/null
+++ b/Documentation/SubmittingPatches
@@ -0,0 +1 @@
+./process/submitting-patches.rst
\ No newline at end of file
-- 
2.10.0.rc2.1.g053435c

[toc] | [next] | [standalone]

#1556293

On Wed, 11 Jan 2017, Joe Perches <joe@perches.com> wrote:
> Make these files symlinks to the .rst equivalents

If we're going to do this (and I really don't mind either way), then
please add

Fixes: 08a9a8d44c1c ("doc: re-add CodingStyle and SubmittingPatches")

and queue to v4.10-rc.

BR,
Jani.

>
> Signed-off-by: Joe Perches <joe@perches.com>
> ---
>  Documentation/CodingStyle       | 2 +-
>  Documentation/SubmittingPatches | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
>  mode change 100644 => 120000 Documentation/CodingStyle
>  mode change 100644 => 120000 Documentation/SubmittingPatches
>
> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> deleted file mode 100644
> index 320983ca114e..000000000000
> --- a/Documentation/CodingStyle
> +++ /dev/null
> @@ -1 +0,0 @@
> -This file has moved to process/coding-style.rst
> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> new file mode 120000
> index 000000000000..5aacf7ea935a
> --- /dev/null
> +++ b/Documentation/CodingStyle
> @@ -0,0 +1 @@
> +./process/coding-style.rst
> \ No newline at end of file
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> deleted file mode 100644
> index 81455705e4a6..000000000000
> --- a/Documentation/SubmittingPatches
> +++ /dev/null
> @@ -1 +0,0 @@
> -This file has moved to process/submitting-patches.rst
> diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
> new file mode 120000
> index 000000000000..5ca6e8ba3682
> --- /dev/null
> +++ b/Documentation/SubmittingPatches
> @@ -0,0 +1 @@
> +./process/submitting-patches.rst
> \ No newline at end of file

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]

#1556320

On Wed, 2017-01-11 at 10:54 +0200, Jani Nikula wrote:
> On Wed, 11 Jan 2017, Joe Perches <joe@perches.com> wrote:
> > Make these files symlinks to the .rst equivalents
> 
> If we're going to do this (and I really don't mind either way), then
> please add
> 
> Fixes: 08a9a8d44c1c ("doc: re-add CodingStyle and SubmittingPatches")

I don't believe this patch "fixes" the other, it just makes it
possible to continue to write "Read Documentation/CodingStyle"
or "Read Documentation/SubmittingPatches" to people that
submit poorly formatted or improper patches.

I attempted to do that a bit ago but then had to write out the
Documentation/process/<foo>.rst equivalents instead.

[toc] | [prev] | [next] | [standalone]

#1556332

On Wed, 11 Jan 2017, Joe Perches <joe@perches.com> wrote:
> On Wed, 2017-01-11 at 10:54 +0200, Jani Nikula wrote:
>> On Wed, 11 Jan 2017, Joe Perches <joe@perches.com> wrote:
>> > Make these files symlinks to the .rst equivalents
>> 
>> If we're going to do this (and I really don't mind either way), then
>> please add
>> 
>> Fixes: 08a9a8d44c1c ("doc: re-add CodingStyle and SubmittingPatches")

With this I'm merely saying that wherever 08a9a8d44c1c ends up, this
patch should end up too (if we want symlinks that is). There's enough
confusion with the renames already, I'd like to ensure that v4.10
doesn't end up having one thing, and the future another.

BR,
Jani.

>
> I don't believe this patch "fixes" the other, it just makes it
> possible to continue to write "Read Documentation/CodingStyle"
> or "Read Documentation/SubmittingPatches" to people that
> submit poorly formatted or improper patches.
>
> I attempted to do that a bit ago but then had to write out the
> Documentation/process/<foo>.rst equivalents instead.
>

-- 
Jani Nikula, Intel Open Source Technology Center

[toc] | [prev] | [next] | [standalone]

#1558707

On Tue, 10 Jan 2017 14:09:51 -0800
Joe Perches <joe@perches.com> wrote:

> Make these files symlinks to the .rst equivalents

So I am not necessarily opposed to doing this, but the changelog lacks
one important thing: why do we need to make that change?  Have the
existing one-liner files been a problem somehow?

Thanks,

jon

[toc] | [prev] | [next] | [standalone]

#1558714

On Fri, 2017-01-13 at 12:41 -0700, Jonathan Corbet wrote:
> On Tue, 10 Jan 2017 14:09:51 -0800
> Joe Perches <joe@perches.com> wrote:
> 
> > Make these files symlinks to the .rst equivalents
> 
> So I am not necessarily opposed to doing this, but the changelog lacks
> one important thing: why do we need to make that change?  Have the
> existing one-liner files been a problem somehow?

The files tell people to open other files.

Giving the old link to people just tells them to
use the new filename instead.

symlinks open the new file automatically.

$ head Documentation/CodingStyle
This file has moved to process/coding-style.rst

vs a symlink

$ head Documentation/CodingStyle
.. _codingstyle:

Linux kernel coding style
=========================

This is a short document describing the preferred coding style for the
linux kernel.  Coding style is very personal, and I won't **force** my
views on anybody, but this is what goes for anything that I have to be
able to maintain, and I'd prefer it for most other things too.  Please
at least consider the points made here.

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web