All the mail mirrored from lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts
@ 2019-10-12 17:11 Jonathan Neuschäfer
  2019-10-12 17:11   ` Jonathan Neuschäfer
                   ` (3 more replies)
  0 siblings, 4 replies; 8+ messages in thread
From: Jonathan Neuschäfer @ 2019-10-12 17:11 UTC (permalink / raw
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Mauro Carvalho Chehab,
	Matthew Wilcox (Oracle), Shobhit Kukreti, Thomas Gleixner,
	linux-kernel

Since the "unordered guides" linked in admin-guide/index.rst are not
supposed to be in any particular order, let's sort them alphabetically
to avoid the risk of merge conflicts by spreading newly added lines more
evenly.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---

Upon a second look, I noticed that the list wasn't completely unordered:
binfmt-misc is grouped with java and mono, the filesystems are grouped
together.

For the filesystems, I think they should be moved to the filesystems/
directory, and the binfmt documents could perhaps be explicitly grouped
too. But perhaps the loss of this grouping-by-position is reason enough
to drop this patch for now.
---
 Documentation/admin-guide/index.rst | 64 ++++++++++++++---------------
 1 file changed, 32 insertions(+), 32 deletions(-)

diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 34cc20ee7f3a..545ea26364b7 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -57,60 +57,60 @@ configure specific aspects of kernel behavior to your liking.
 .. toctree::
    :maxdepth: 1

-   initrd
-   cgroup-v2
-   cgroup-v1/index
-   serial-console
-   braille-console
-   parport
-   md
-   module-signing
-   rapidio
-   sysrq
-   unicode
-   vga-softcursor
-   binfmt-misc
-   mono
-   java
-   ras
-   bcache
-   blockdev/index
-   ext4
-   binderfs
-   cifs/index
-   xfs
-   jfs
-   ufs
-   pm/index
-   thunderbolt
-   LSM/index
-   mm/index
-   namespaces/index
-   perf-security
    acpi/index
    aoe/index
+   auxdisplay/index
+   bcache
+   binderfs
+   binfmt-misc
+   blockdev/index
+   braille-console
    btmrvl
+   cgroup-v1/index
+   cgroup-v2
+   cifs/index
    clearing-warn-once
    cpu-load
    cputopology
    device-mapper/index
    efi-stub
+   ext4
    gpio/index
    highuid
    hw_random
+   initrd
    iostats
+   java
+   jfs
    kernel-per-CPU-kthreads
    laptops/index
-   auxdisplay/index
    lcd-panel-cgram
    ldm
    lockup-watchdogs
+   LSM/index
+   md
+   mm/index
+   module-signing
+   mono
+   namespaces/index
    numastat
+   parport
+   perf-security
+   pm/index
    pnp
+   rapidio
+   ras
    rtc
+   serial-console
    svga
-   wimax/index
+   sysrq
+   thunderbolt
+   ufs
+   unicode
+   vga-softcursor
    video-output
+   wimax/index
+   xfs

 .. only::  subproject and html

--
2.20.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api
  2019-10-12 17:11 [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Neuschäfer
@ 2019-10-12 17:11   ` Jonathan Neuschäfer
  2019-10-12 17:11 ` [PATCH 3/4] docs: admin-guide: dell_rbu: Rework the title Jonathan Neuschäfer
                     ` (2 subsequent siblings)
  3 siblings, 0 replies; 8+ messages in thread
From: Jonathan Neuschäfer @ 2019-10-12 17:11 UTC (permalink / raw
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Darren Hart,
	Andy Shevchenko, Stuart Hayes, Mauro Carvalho Chehab,
	Logan Gunthorpe, Cornelia Huck, Darrick J. Wong, Shobhit Kukreti,
	Thomas Gleixner, Greg Kroah-Hartman, Rafael J. Wysocki,
	Sinan Kaya, Takashi Iwai, Ayman Bagabas, Matan Ziv-Av,
	Hans de Goede, Enrico Weigelt, metux IT consult, Peng Hao,
	Krzysztof Kozlowski, linux-kernel, platform-driver-x86

This document describes how an admin can use the dell_rbu driver, rather
than any in-kernel API details.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/{driver-api => admin-guide}/dell_rbu.rst | 0
 Documentation/admin-guide/index.rst                    | 1 +
 Documentation/driver-api/index.rst                     | 1 -
 drivers/platform/x86/Kconfig                           | 2 +-
 drivers/platform/x86/dell_rbu.c                        | 2 +-
 5 files changed, 3 insertions(+), 3 deletions(-)
 rename Documentation/{driver-api => admin-guide}/dell_rbu.rst (100%)

diff --git a/Documentation/driver-api/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
similarity index 100%
rename from Documentation/driver-api/dell_rbu.rst
rename to Documentation/admin-guide/dell_rbu.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 545ea26364b7..4405b7485312 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -72,6 +72,7 @@ configure specific aspects of kernel behavior to your liking.
    clearing-warn-once
    cpu-load
    cputopology
+   dell_rbu
    device-mapper/index
    efi-stub
    ext4
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 2b3b6949381e..6a3ac50f51f0 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -72,7 +72,6 @@ available subsections can be seen below.
    connector
    console
    dcdbas
-   dell_rbu
    edid
    eisa
    ipmb
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index ae21d08c65e8..a890f47fbeec 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -259,7 +259,7 @@ config DELL_RBU
 	 DELL system. Note you need a Dell OpenManage or Dell Update package (DUP)
 	 supporting application to communicate with the BIOS regarding the new
 	 image for the image update to take effect.
-	 See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver.
+	 See <file:Documentation/admin-guide/dell_rbu.rst> for more details on the driver.


 config FUJITSU_LAPTOP
diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c
index 3691391fea6b..7d5453326b43 100644
--- a/drivers/platform/x86/dell_rbu.c
+++ b/drivers/platform/x86/dell_rbu.c
@@ -24,7 +24,7 @@
  * on every time the packet data is written. This driver requires an
  * application to break the BIOS image in to fixed sized packet chunks.
  *
- * See Documentation/driver-api/dell_rbu.rst for more info.
+ * See Documentation/admin-guide/dell_rbu.rst for more info.
  */
 #include <linux/init.h>
 #include <linux/module.h>
--
2.20.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api
@ 2019-10-12 17:11   ` Jonathan Neuschäfer
  0 siblings, 0 replies; 8+ messages in thread
From: Jonathan Neuschäfer @ 2019-10-12 17:11 UTC (permalink / raw
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Darren Hart,
	Andy Shevchenko, Stuart Hayes, Mauro Carvalho Chehab,
	Logan Gunthorpe, Cornelia Huck, Darrick J. Wong, Shobhit Kukreti,
	Thomas Gleixner, Greg Kroah-Hartman, Rafael J. Wysocki,
	Sinan Kaya, Takashi Iwai, Ayman Bagabas, Matan Ziv-Av,
	Hans de Goede

This document describes how an admin can use the dell_rbu driver, rather
than any in-kernel API details.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/{driver-api => admin-guide}/dell_rbu.rst | 0
 Documentation/admin-guide/index.rst                    | 1 +
 Documentation/driver-api/index.rst                     | 1 -
 drivers/platform/x86/Kconfig                           | 2 +-
 drivers/platform/x86/dell_rbu.c                        | 2 +-
 5 files changed, 3 insertions(+), 3 deletions(-)
 rename Documentation/{driver-api => admin-guide}/dell_rbu.rst (100%)

diff --git a/Documentation/driver-api/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
similarity index 100%
rename from Documentation/driver-api/dell_rbu.rst
rename to Documentation/admin-guide/dell_rbu.rst
diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
index 545ea26364b7..4405b7485312 100644
--- a/Documentation/admin-guide/index.rst
+++ b/Documentation/admin-guide/index.rst
@@ -72,6 +72,7 @@ configure specific aspects of kernel behavior to your liking.
    clearing-warn-once
    cpu-load
    cputopology
+   dell_rbu
    device-mapper/index
    efi-stub
    ext4
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 2b3b6949381e..6a3ac50f51f0 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -72,7 +72,6 @@ available subsections can be seen below.
    connector
    console
    dcdbas
-   dell_rbu
    edid
    eisa
    ipmb
diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
index ae21d08c65e8..a890f47fbeec 100644
--- a/drivers/platform/x86/Kconfig
+++ b/drivers/platform/x86/Kconfig
@@ -259,7 +259,7 @@ config DELL_RBU
 	 DELL system. Note you need a Dell OpenManage or Dell Update package (DUP)
 	 supporting application to communicate with the BIOS regarding the new
 	 image for the image update to take effect.
-	 See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver.
+	 See <file:Documentation/admin-guide/dell_rbu.rst> for more details on the driver.


 config FUJITSU_LAPTOP
diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c
index 3691391fea6b..7d5453326b43 100644
--- a/drivers/platform/x86/dell_rbu.c
+++ b/drivers/platform/x86/dell_rbu.c
@@ -24,7 +24,7 @@
  * on every time the packet data is written. This driver requires an
  * application to break the BIOS image in to fixed sized packet chunks.
  *
- * See Documentation/driver-api/dell_rbu.rst for more info.
+ * See Documentation/admin-guide/dell_rbu.rst for more info.
  */
 #include <linux/init.h>
 #include <linux/module.h>
--
2.20.1

^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 3/4] docs: admin-guide: dell_rbu: Rework the title
  2019-10-12 17:11 [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Neuschäfer
  2019-10-12 17:11   ` Jonathan Neuschäfer
@ 2019-10-12 17:11 ` Jonathan Neuschäfer
  2019-10-12 17:11 ` [PATCH 4/4] docs: admin-guide: dell_rbu: Improve formatting and spelling Jonathan Neuschäfer
  2019-10-15 18:38 ` [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Corbet
  3 siblings, 0 replies; 8+ messages in thread
From: Jonathan Neuschäfer @ 2019-10-12 17:11 UTC (permalink / raw
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Cornelia Huck,
	Mauro Carvalho Chehab, Logan Gunthorpe, linux-kernel

- Mention the driver name, which is also used in sysfs (dell_rbu)
- Rewrite the title to be more concise

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/admin-guide/dell_rbu.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
index 5d1ce7bcd04d..10830db9e616 100644
--- a/Documentation/admin-guide/dell_rbu.rst
+++ b/Documentation/admin-guide/dell_rbu.rst
@@ -1,6 +1,6 @@
-=============================================================
-Usage of the new open sourced rbu (Remote BIOS Update) driver
-=============================================================
+=========================================
+Dell Remote BIOS Update driver (dell_rbu)
+=========================================
 
 Purpose
 =======
-- 
2.20.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* [PATCH 4/4] docs: admin-guide: dell_rbu: Improve formatting and spelling
  2019-10-12 17:11 [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Neuschäfer
  2019-10-12 17:11   ` Jonathan Neuschäfer
  2019-10-12 17:11 ` [PATCH 3/4] docs: admin-guide: dell_rbu: Rework the title Jonathan Neuschäfer
@ 2019-10-12 17:11 ` Jonathan Neuschäfer
  2019-10-15 18:38 ` [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Corbet
  3 siblings, 0 replies; 8+ messages in thread
From: Jonathan Neuschäfer @ 2019-10-12 17:11 UTC (permalink / raw
  To: linux-doc
  Cc: Jonathan Neuschäfer, Jonathan Corbet, Cornelia Huck,
	Logan Gunthorpe, Mauro Carvalho Chehab, linux-kernel

This improves readability a bit.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/admin-guide/dell_rbu.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/admin-guide/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
index 10830db9e616..8d70e1fc9f9d 100644
--- a/Documentation/admin-guide/dell_rbu.rst
+++ b/Documentation/admin-guide/dell_rbu.rst
@@ -5,7 +5,7 @@ Dell Remote BIOS Update driver (dell_rbu)
 Purpose
 =======

-Document demonstrating the use of the Dell Remote BIOS Update driver.
+Document demonstrating the use of the Dell Remote BIOS Update driver
 for updating BIOS images on Dell servers and desktops.

 Scope
@@ -37,7 +37,7 @@ maintains a link list of packets for reading them back.

 If the dell_rbu driver is unloaded all the allocated memory is freed.

-The rbu driver needs to have an application (as mentioned above)which will
+The rbu driver needs to have an application (as mentioned above) which will
 inform the BIOS to enable the update in the next system reboot.

 The user should not unload the rbu driver after downloading the BIOS image
@@ -71,7 +71,7 @@ be downloaded. It is done as below::
 	echo XXXX > /sys/devices/platform/dell_rbu/packet_size

 In the packet update mechanism, the user needs to create a new file having
-packets of data arranged back to back. It can be done as follows
+packets of data arranged back to back. It can be done as follows:
 The user creates packets header, gets the chunk of the BIOS image and
 places it next to the packetheader; now, the packetheader + BIOS image chunk
 added together should match the specified packet_size. This makes one
@@ -114,7 +114,7 @@ The entries can be recreated by doing the following::

 	echo init > /sys/devices/platform/dell_rbu/image_type

-.. note:: echoing init in image_type does not change it original value.
+.. note:: echoing init in image_type does not change its original value.

 Also the driver provides /sys/devices/platform/dell_rbu/data readonly file to
 read back the image downloaded.
--
2.20.1


^ permalink raw reply related	[flat|nested] 8+ messages in thread

* Re: [PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api
  2019-10-12 17:11   ` Jonathan Neuschäfer
@ 2019-10-13  6:23     ` Andy Shevchenko
  -1 siblings, 0 replies; 8+ messages in thread
From: Andy Shevchenko @ 2019-10-13  6:23 UTC (permalink / raw
  To: Jonathan Neuschäfer
  Cc: Linux Documentation List, Jonathan Corbet, Darren Hart,
	Andy Shevchenko, Stuart Hayes, Mauro Carvalho Chehab,
	Logan Gunthorpe, Cornelia Huck, Darrick J. Wong, Shobhit Kukreti,
	Thomas Gleixner, Greg Kroah-Hartman, Rafael J. Wysocki,
	Sinan Kaya, Takashi Iwai, Ayman Bagabas, Matan Ziv-Av,
	Hans de Goede, Enrico Weigelt, metux IT consult, Peng Hao,
	Krzysztof Kozlowski, Linux Kernel Mailing List, Platform Driver

On Sat, Oct 12, 2019 at 8:17 PM Jonathan Neuschäfer
<j.neuschaefer@gmx.net> wrote:
>
> This document describes how an admin can use the dell_rbu driver, rather
> than any in-kernel API details.

Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
>  Documentation/{driver-api => admin-guide}/dell_rbu.rst | 0
>  Documentation/admin-guide/index.rst                    | 1 +
>  Documentation/driver-api/index.rst                     | 1 -
>  drivers/platform/x86/Kconfig                           | 2 +-
>  drivers/platform/x86/dell_rbu.c                        | 2 +-
>  5 files changed, 3 insertions(+), 3 deletions(-)
>  rename Documentation/{driver-api => admin-guide}/dell_rbu.rst (100%)
>
> diff --git a/Documentation/driver-api/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
> similarity index 100%
> rename from Documentation/driver-api/dell_rbu.rst
> rename to Documentation/admin-guide/dell_rbu.rst
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index 545ea26364b7..4405b7485312 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -72,6 +72,7 @@ configure specific aspects of kernel behavior to your liking.
>     clearing-warn-once
>     cpu-load
>     cputopology
> +   dell_rbu
>     device-mapper/index
>     efi-stub
>     ext4
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index 2b3b6949381e..6a3ac50f51f0 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -72,7 +72,6 @@ available subsections can be seen below.
>     connector
>     console
>     dcdbas
> -   dell_rbu
>     edid
>     eisa
>     ipmb
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index ae21d08c65e8..a890f47fbeec 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -259,7 +259,7 @@ config DELL_RBU
>          DELL system. Note you need a Dell OpenManage or Dell Update package (DUP)
>          supporting application to communicate with the BIOS regarding the new
>          image for the image update to take effect.
> -        See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver.
> +        See <file:Documentation/admin-guide/dell_rbu.rst> for more details on the driver.
>
>
>  config FUJITSU_LAPTOP
> diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c
> index 3691391fea6b..7d5453326b43 100644
> --- a/drivers/platform/x86/dell_rbu.c
> +++ b/drivers/platform/x86/dell_rbu.c
> @@ -24,7 +24,7 @@
>   * on every time the packet data is written. This driver requires an
>   * application to break the BIOS image in to fixed sized packet chunks.
>   *
> - * See Documentation/driver-api/dell_rbu.rst for more info.
> + * See Documentation/admin-guide/dell_rbu.rst for more info.
>   */
>  #include <linux/init.h>
>  #include <linux/module.h>
> --
> 2.20.1
>


-- 
With Best Regards,
Andy Shevchenko

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api
@ 2019-10-13  6:23     ` Andy Shevchenko
  0 siblings, 0 replies; 8+ messages in thread
From: Andy Shevchenko @ 2019-10-13  6:23 UTC (permalink / raw
  To: Jonathan Neuschäfer
  Cc: Linux Documentation List, Jonathan Corbet, Darren Hart,
	Andy Shevchenko, Stuart Hayes, Mauro Carvalho Chehab,
	Logan Gunthorpe, Cornelia Huck, Darrick J. Wong, Shobhit Kukreti,
	Thomas Gleixner, Greg Kroah-Hartman, Rafael J. Wysocki,
	Sinan Kaya, Takashi Iwai, Ayman Bagabas, Matan Ziv-Av,
	Hans de Goede, Enrico 

On Sat, Oct 12, 2019 at 8:17 PM Jonathan Neuschäfer
<j.neuschaefer@gmx.net> wrote:
>
> This document describes how an admin can use the dell_rbu driver, rather
> than any in-kernel API details.

Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com>

> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
> ---
>  Documentation/{driver-api => admin-guide}/dell_rbu.rst | 0
>  Documentation/admin-guide/index.rst                    | 1 +
>  Documentation/driver-api/index.rst                     | 1 -
>  drivers/platform/x86/Kconfig                           | 2 +-
>  drivers/platform/x86/dell_rbu.c                        | 2 +-
>  5 files changed, 3 insertions(+), 3 deletions(-)
>  rename Documentation/{driver-api => admin-guide}/dell_rbu.rst (100%)
>
> diff --git a/Documentation/driver-api/dell_rbu.rst b/Documentation/admin-guide/dell_rbu.rst
> similarity index 100%
> rename from Documentation/driver-api/dell_rbu.rst
> rename to Documentation/admin-guide/dell_rbu.rst
> diff --git a/Documentation/admin-guide/index.rst b/Documentation/admin-guide/index.rst
> index 545ea26364b7..4405b7485312 100644
> --- a/Documentation/admin-guide/index.rst
> +++ b/Documentation/admin-guide/index.rst
> @@ -72,6 +72,7 @@ configure specific aspects of kernel behavior to your liking.
>     clearing-warn-once
>     cpu-load
>     cputopology
> +   dell_rbu
>     device-mapper/index
>     efi-stub
>     ext4
> diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
> index 2b3b6949381e..6a3ac50f51f0 100644
> --- a/Documentation/driver-api/index.rst
> +++ b/Documentation/driver-api/index.rst
> @@ -72,7 +72,6 @@ available subsections can be seen below.
>     connector
>     console
>     dcdbas
> -   dell_rbu
>     edid
>     eisa
>     ipmb
> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig
> index ae21d08c65e8..a890f47fbeec 100644
> --- a/drivers/platform/x86/Kconfig
> +++ b/drivers/platform/x86/Kconfig
> @@ -259,7 +259,7 @@ config DELL_RBU
>          DELL system. Note you need a Dell OpenManage or Dell Update package (DUP)
>          supporting application to communicate with the BIOS regarding the new
>          image for the image update to take effect.
> -        See <file:Documentation/driver-api/dell_rbu.rst> for more details on the driver.
> +        See <file:Documentation/admin-guide/dell_rbu.rst> for more details on the driver.
>
>
>  config FUJITSU_LAPTOP
> diff --git a/drivers/platform/x86/dell_rbu.c b/drivers/platform/x86/dell_rbu.c
> index 3691391fea6b..7d5453326b43 100644
> --- a/drivers/platform/x86/dell_rbu.c
> +++ b/drivers/platform/x86/dell_rbu.c
> @@ -24,7 +24,7 @@
>   * on every time the packet data is written. This driver requires an
>   * application to break the BIOS image in to fixed sized packet chunks.
>   *
> - * See Documentation/driver-api/dell_rbu.rst for more info.
> + * See Documentation/admin-guide/dell_rbu.rst for more info.
>   */
>  #include <linux/init.h>
>  #include <linux/module.h>
> --
> 2.20.1
>


-- 
With Best Regards,
Andy Shevchenko

^ permalink raw reply	[flat|nested] 8+ messages in thread

* Re: [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts
  2019-10-12 17:11 [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Neuschäfer
                   ` (2 preceding siblings ...)
  2019-10-12 17:11 ` [PATCH 4/4] docs: admin-guide: dell_rbu: Improve formatting and spelling Jonathan Neuschäfer
@ 2019-10-15 18:38 ` Jonathan Corbet
  3 siblings, 0 replies; 8+ messages in thread
From: Jonathan Corbet @ 2019-10-15 18:38 UTC (permalink / raw
  To: Jonathan Neuschäfer
  Cc: linux-doc, Mauro Carvalho Chehab, Matthew Wilcox (Oracle),
	Shobhit Kukreti, Thomas Gleixner, linux-kernel

On Sat, 12 Oct 2019 19:11:09 +0200
Jonathan Neuschäfer <j.neuschaefer@gmx.net> wrote:

> Since the "unordered guides" linked in admin-guide/index.rst are not
> supposed to be in any particular order, let's sort them alphabetically
> to avoid the risk of merge conflicts by spreading newly added lines more
> evenly.
> 
> Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>

I've applied this as being better than nothing, but I would *really* be
pleased if somebody could spend some time imposing a more interesting
order on those unordered guides.  Making readers pick through a long list
of random documents isn't all that friendly.

(The rest of the set is applied as well).

Thanks,

jon

^ permalink raw reply	[flat|nested] 8+ messages in thread

end of thread, other threads:[~2019-10-15 18:38 UTC | newest]

Thread overview: 8+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2019-10-12 17:11 [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Neuschäfer
2019-10-12 17:11 ` [PATCH 2/4] docs: admin-guide: Move Dell RBU document from driver-api Jonathan Neuschäfer
2019-10-12 17:11   ` Jonathan Neuschäfer
2019-10-13  6:23   ` Andy Shevchenko
2019-10-13  6:23     ` Andy Shevchenko
2019-10-12 17:11 ` [PATCH 3/4] docs: admin-guide: dell_rbu: Rework the title Jonathan Neuschäfer
2019-10-12 17:11 ` [PATCH 4/4] docs: admin-guide: dell_rbu: Improve formatting and spelling Jonathan Neuschäfer
2019-10-15 18:38 ` [PATCH RFC 1/4] docs: admin-guide: Sort the "unordered guides" to avoid merge conflicts Jonathan Corbet

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.