linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/7] Fix broken references to files under Documentation/*
@ 2019-07-26 11:47 Mauro Carvalho Chehab
  2019-07-26 19:55 ` Atish Patra
       [not found] ` <CGME20190809101313eucas1p1363a5f60c06081bd9b2ef9b45248414f@eucas1p1.samsung.com>
  0 siblings, 2 replies; 10+ messages in thread
From: Mauro Carvalho Chehab @ 2019-07-26 11:47 UTC (permalink / raw)
  Cc: Mauro Carvalho Chehab, linux-doc, linux-kernel, Atish Patra,
	Łukasz Stelmach, Rob Herring

Solves most of the pending broken references upstream, except for two of
them:

	$ ./scripts/documentation-file-ref-check 
	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt

As written at boot-image-header.txt, it is waiting for the addition of
a future file: 

	"The complete booting guide will be available at
	  Documentation/riscv/booting.txt."

The second is due to this patch, pending to be merged:
	https://lore.kernel.org/patchwork/patch/994210/

I'm not a DT expert, but I can't see any issue with this patch, except
for a missing acked-by a DT maintainer, and a possible conversion to
yaml. IMO, the best fix for this would be to merge the DT patch.

Patch 1 was already submitted before, together with the v1 of
my PDF fix series.

Mauro Carvalho Chehab (7):
  docs: fix broken doc references due to renames
  docs: generic-counter.rst: fix broken references for ABI file
  MAINTAINERS: fix reference to net phy ABI file
  MAINTAINERS: fix a renamed DT reference
  docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
  docs: zh_CN: howto.rst: fix a broken reference
  docs: dt: fix a sound binding broken reference

 Documentation/RCU/rculist_nulls.txt                |  2 +-
 .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
 .../devicetree/bindings/arm/idle-states.txt        |  2 +-
 .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
 Documentation/driver-api/generic-counter.rst       |  4 ++--
 Documentation/locking/spinlocks.rst                |  4 ++--
 Documentation/memory-barriers.txt                  |  2 +-
 .../translations/ko_KR/memory-barriers.txt         |  2 +-
 Documentation/translations/zh_CN/process/howto.rst |  2 +-
 Documentation/watchdog/hpwdt.rst                   |  2 +-
 MAINTAINERS                                        | 14 +++++++-------
 drivers/gpu/drm/drm_modes.c                        |  2 +-
 drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
 drivers/scsi/hpsa.c                                |  4 ++--
 14 files changed, 22 insertions(+), 28 deletions(-)

-- 
2.21.0



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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
  2019-07-26 11:47 [PATCH 0/7] Fix broken references to files under Documentation/* Mauro Carvalho Chehab
@ 2019-07-26 19:55 ` Atish Patra
  2019-07-26 20:13   ` Mauro Carvalho Chehab
       [not found] ` <CGME20190809101313eucas1p1363a5f60c06081bd9b2ef9b45248414f@eucas1p1.samsung.com>
  1 sibling, 1 reply; 10+ messages in thread
From: Atish Patra @ 2019-07-26 19:55 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: linux-doc, linux-kernel, Łukasz Stelmach, Rob Herring

On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
> Solves most of the pending broken references upstream, except for two of
> them:
> 
> 	$ ./scripts/documentation-file-ref-check
> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> 
> As written at boot-image-header.txt, it is waiting for the addition of
> a future file:
> 
> 	"The complete booting guide will be available at
> 	  Documentation/riscv/booting.txt."
> 

Yeah. We don't have complete booting guide defined in RISC-V land.
Documentation/riscv/booting.txt will be available once we have that.

In the mean time, do we need to convert boot-image-header.txt to 
boot-image-header.rst and fix the reference to 
Documentation/riscv/booting.rst as well ?

> The second is due to this patch, pending to be merged:
> 	https://lore.kernel.org/patchwork/patch/994210/
> 
> I'm not a DT expert, but I can't see any issue with this patch, except
> for a missing acked-by a DT maintainer, and a possible conversion to
> yaml. IMO, the best fix for this would be to merge the DT patch.
> 
> Patch 1 was already submitted before, together with the v1 of
> my PDF fix series.
> 
> Mauro Carvalho Chehab (7):
>    docs: fix broken doc references due to renames
>    docs: generic-counter.rst: fix broken references for ABI file
>    MAINTAINERS: fix reference to net phy ABI file
>    MAINTAINERS: fix a renamed DT reference
>    docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
>    docs: zh_CN: howto.rst: fix a broken reference
>    docs: dt: fix a sound binding broken reference
> 
>   Documentation/RCU/rculist_nulls.txt                |  2 +-
>   .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
>   .../devicetree/bindings/arm/idle-states.txt        |  2 +-
>   .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
>   Documentation/driver-api/generic-counter.rst       |  4 ++--
>   Documentation/locking/spinlocks.rst                |  4 ++--
>   Documentation/memory-barriers.txt                  |  2 +-
>   .../translations/ko_KR/memory-barriers.txt         |  2 +-
>   Documentation/translations/zh_CN/process/howto.rst |  2 +-
>   Documentation/watchdog/hpwdt.rst                   |  2 +-
>   MAINTAINERS                                        | 14 +++++++-------
>   drivers/gpu/drm/drm_modes.c                        |  2 +-
>   drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
>   drivers/scsi/hpsa.c                                |  4 ++--
>   14 files changed, 22 insertions(+), 28 deletions(-)
> 


-- 
Regards,
Atish

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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
  2019-07-26 19:55 ` Atish Patra
@ 2019-07-26 20:13   ` Mauro Carvalho Chehab
  2019-07-26 20:18     ` Atish Patra
  0 siblings, 1 reply; 10+ messages in thread
From: Mauro Carvalho Chehab @ 2019-07-26 20:13 UTC (permalink / raw)
  To: Atish Patra; +Cc: linux-doc, linux-kernel, Łukasz Stelmach, Rob Herring

Em Fri, 26 Jul 2019 12:55:36 -0700
Atish Patra <atish.patra@wdc.com> escreveu:

> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
> > Solves most of the pending broken references upstream, except for two of
> > them:
> > 
> > 	$ ./scripts/documentation-file-ref-check
> > 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> > 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> > 
> > As written at boot-image-header.txt, it is waiting for the addition of
> > a future file:
> > 
> > 	"The complete booting guide will be available at
> > 	  Documentation/riscv/booting.txt."
> >   
> 
> Yeah. We don't have complete booting guide defined in RISC-V land.
> Documentation/riscv/booting.txt will be available once we have that.
> 
> In the mean time, do we need to convert boot-image-header.txt to 
> boot-image-header.rst and fix the reference to 
> Documentation/riscv/booting.rst as well ?

Well, in the mean time, every time someone builds the Kernel with
COMPILE_TEST enabled, a warning will be produced.

So, my suggestion would be to write it on a different way, like:

	"A complete booting guide is being written and should be
	 available on future versions."

Or:
	TODO:
	   Write a complete booting guide.

And update this once the guide is finished. This should be enough
to prevent the warning.

With regards to converting it to ReST, that's recommended. I suspect
we could be able to finish the entire doc conversion in a couple
Kernel versions. 

Also, it should be really trivial to convert this one to ReST.

Thanks,
Mauro

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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
  2019-07-26 20:13   ` Mauro Carvalho Chehab
@ 2019-07-26 20:18     ` Atish Patra
  2019-07-26 21:01       ` Mauro Carvalho Chehab
  2019-07-26 21:01       ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
  0 siblings, 2 replies; 10+ messages in thread
From: Atish Patra @ 2019-07-26 20:18 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: linux-doc, linux-kernel, Łukasz Stelmach, Rob Herring

On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 26 Jul 2019 12:55:36 -0700
> Atish Patra <atish.patra@wdc.com> escreveu:
> 
>> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
>>> Solves most of the pending broken references upstream, except for two of
>>> them:
>>>
>>> 	$ ./scripts/documentation-file-ref-check
>>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
>>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>
>>> As written at boot-image-header.txt, it is waiting for the addition of
>>> a future file:
>>>
>>> 	"The complete booting guide will be available at
>>> 	  Documentation/riscv/booting.txt."
>>>    
>>
>> Yeah. We don't have complete booting guide defined in RISC-V land.
>> Documentation/riscv/booting.txt will be available once we have that.
>>
>> In the mean time, do we need to convert boot-image-header.txt to
>> boot-image-header.rst and fix the reference to
>> Documentation/riscv/booting.rst as well ?
> 
> Well, in the mean time, every time someone builds the Kernel with
> COMPILE_TEST enabled, a warning will be produced.
> 
> So, my suggestion would be to write it on a different way, like:
> 
> 	"A complete booting guide is being written and should be
> 	 available on future versions."
> 
> Or:
> 	TODO:
> 	   Write a complete booting guide.
> 
> And update this once the guide is finished. This should be enough
> to prevent the warning.
> 

Sounds good to me.

> With regards to converting it to ReST, that's recommended. I suspect
> we could be able to finish the entire doc conversion in a couple
> Kernel versions.
> 
Sure.

> Also, it should be really trivial to convert this one to ReST.
> 

Yes. Let me know if you prefer to update it along with your series or I 
will send the patch.

> Thanks,
> Mauro
> 


-- 
Regards,
Atish

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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
  2019-07-26 20:18     ` Atish Patra
@ 2019-07-26 21:01       ` Mauro Carvalho Chehab
  2019-07-26 22:16         ` Atish Patra
  2019-07-26 21:01       ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
  1 sibling, 1 reply; 10+ messages in thread
From: Mauro Carvalho Chehab @ 2019-07-26 21:01 UTC (permalink / raw)
  To: Atish Patra; +Cc: linux-doc, linux-kernel, Łukasz Stelmach, Rob Herring

Em Fri, 26 Jul 2019 13:18:30 -0700
Atish Patra <atish.patra@wdc.com> escreveu:

> On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
> > Em Fri, 26 Jul 2019 12:55:36 -0700
> > Atish Patra <atish.patra@wdc.com> escreveu:
> >   
> >> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:  
> >>> Solves most of the pending broken references upstream, except for two of
> >>> them:
> >>>
> >>> 	$ ./scripts/documentation-file-ref-check
> >>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> >>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
> >>>
> >>> As written at boot-image-header.txt, it is waiting for the addition of
> >>> a future file:
> >>>
> >>> 	"The complete booting guide will be available at
> >>> 	  Documentation/riscv/booting.txt."
> >>>      
> >>
> >> Yeah. We don't have complete booting guide defined in RISC-V land.
> >> Documentation/riscv/booting.txt will be available once we have that.
> >>
> >> In the mean time, do we need to convert boot-image-header.txt to
> >> boot-image-header.rst and fix the reference to
> >> Documentation/riscv/booting.rst as well ?  
> > 
> > Well, in the mean time, every time someone builds the Kernel with
> > COMPILE_TEST enabled, a warning will be produced.
> > 
> > So, my suggestion would be to write it on a different way, like:
> > 
> > 	"A complete booting guide is being written and should be
> > 	 available on future versions."
> > 
> > Or:
> > 	TODO:
> > 	   Write a complete booting guide.
> > 
> > And update this once the guide is finished. This should be enough
> > to prevent the warning.
> >   
> 
> Sounds good to me.
> 
> > With regards to converting it to ReST, that's recommended. I suspect
> > we could be able to finish the entire doc conversion in a couple
> > Kernel versions.
> >   
> Sure.
> 
> > Also, it should be really trivial to convert this one to ReST.
> >   
> 
> Yes. Let me know if you prefer to update it along with your series or I 
> will send the patch.

I suspect it would be quicker if I write it. I'm sending it in a
few.

Thanks,
Mauro

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

* [PATCH] docs: riscv: convert boot-image-header.txt to ReST
  2019-07-26 20:18     ` Atish Patra
  2019-07-26 21:01       ` Mauro Carvalho Chehab
@ 2019-07-26 21:01       ` Mauro Carvalho Chehab
  2019-07-26 22:24         ` Atish Patra
  2019-07-31 19:02         ` Jonathan Corbet
  1 sibling, 2 replies; 10+ messages in thread
From: Mauro Carvalho Chehab @ 2019-07-26 21:01 UTC (permalink / raw)
  To: Linux Doc Mailing List
  Cc: Mauro Carvalho Chehab, Mauro Carvalho Chehab, linux-kernel,
	Jonathan Corbet, Atish Patra, Paul Walmsley, Palmer Dabbelt,
	Albert Ou, Karsten Merker, Linus Walleij, linux-riscv

Convert this small file to ReST format by:
   - Using a proper markup for the document title;
   - marking a code block as such;
   - use tags for Author and date;
   - use tables for bit map fields.

While here, fix a broken reference for a document with is
planned but is not here yet.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 ...image-header.txt => boot-image-header.rst} | 39 ++++++++++++-------
 Documentation/riscv/index.rst                 |  1 +
 2 files changed, 26 insertions(+), 14 deletions(-)
 rename Documentation/riscv/{boot-image-header.txt => boot-image-header.rst} (72%)

diff --git a/Documentation/riscv/boot-image-header.txt b/Documentation/riscv/boot-image-header.rst
similarity index 72%
rename from Documentation/riscv/boot-image-header.txt
rename to Documentation/riscv/boot-image-header.rst
index 1b73fea23b39..43e9bd0731d5 100644
--- a/Documentation/riscv/boot-image-header.txt
+++ b/Documentation/riscv/boot-image-header.rst
@@ -1,22 +1,25 @@
-				Boot image header in RISC-V Linux
-			=============================================
+=================================
+Boot image header in RISC-V Linux
+=================================
 
-Author: Atish Patra <atish.patra@wdc.com>
-Date  : 20 May 2019
+:Author: Atish Patra <atish.patra@wdc.com>
+:Date:   20 May 2019
 
 This document only describes the boot image header details for RISC-V Linux.
-The complete booting guide will be available at Documentation/riscv/booting.txt.
 
-The following 64-byte header is present in decompressed Linux kernel image.
+TODO:
+  Write a complete booting guide.
+
+The following 64-byte header is present in decompressed Linux kernel image::
 
 	u32 code0;		  /* Executable code */
-	u32 code1; 		  /* Executable code */
+	u32 code1;		  /* Executable code */
 	u64 text_offset;	  /* Image load offset, little endian */
 	u64 image_size;		  /* Effective Image size, little endian */
 	u64 flags;		  /* kernel flags, little endian */
 	u32 version;		  /* Version of this header */
-	u32 res1  = 0;		  /* Reserved */
-	u64 res2  = 0;    	  /* Reserved */
+	u32 res1 = 0;		  /* Reserved */
+	u64 res2 = 0;		  /* Reserved */
 	u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */
 	u32 res3;		  /* Reserved for additional RISC-V specific header */
 	u32 res4;		  /* Reserved for PE COFF offset */
@@ -25,16 +28,21 @@ This header format is compliant with PE/COFF header and largely inspired from
 ARM64 header. Thus, both ARM64 & RISC-V header can be combined into one common
 header in future.
 
-Notes:
+Notes
+=====
+
 - This header can also be reused to support EFI stub for RISC-V in future. EFI
   specification needs PE/COFF image header in the beginning of the kernel image
   in order to load it as an EFI application. In order to support EFI stub,
   code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should
   point to the rest of the PE/COFF header.
 
-- version field indicate header version number.
-	Bits 0:15  - Minor version
-	Bits 16:31 - Major version
+- version field indicate header version number
+
+	==========  =============
+	Bits 0:15   Minor version
+	Bits 16:31  Major version
+	==========  =============
 
   This preserves compatibility across newer and older version of the header.
   The current version is defined as 0.1.
@@ -44,7 +52,10 @@ Notes:
   extension for RISC-V in future. For current version, it is set to be zero.
 
 - In current header, the flag field has only one field.
-	Bit 0: Kernel endianness. 1 if BE, 0 if LE.
+
+	=====  ====================================
+	Bit 0  Kernel endianness. 1 if BE, 0 if LE.
+	=====  ====================================
 
 - Image size is mandatory for boot loader to load kernel image. Booting will
   fail otherwise.
diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
index e3ca0922a8c2..215fd3c1f2d5 100644
--- a/Documentation/riscv/index.rst
+++ b/Documentation/riscv/index.rst
@@ -5,6 +5,7 @@ RISC-V architecture
 .. toctree::
     :maxdepth: 1
 
+    boot-image-header
     pmu
 
 .. only::  subproject and html
-- 
2.21.0


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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
  2019-07-26 21:01       ` Mauro Carvalho Chehab
@ 2019-07-26 22:16         ` Atish Patra
  0 siblings, 0 replies; 10+ messages in thread
From: Atish Patra @ 2019-07-26 22:16 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: linux-doc, linux-kernel, Łukasz Stelmach, Rob Herring

On 7/26/19 2:01 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 26 Jul 2019 13:18:30 -0700
> Atish Patra <atish.patra@wdc.com> escreveu:
> 
>> On 7/26/19 1:14 PM, Mauro Carvalho Chehab wrote:
>>> Em Fri, 26 Jul 2019 12:55:36 -0700
>>> Atish Patra <atish.patra@wdc.com> escreveu:
>>>    
>>>> On 7/26/19 4:47 AM, Mauro Carvalho Chehab wrote:
>>>>> Solves most of the pending broken references upstream, except for two of
>>>>> them:
>>>>>
>>>>> 	$ ./scripts/documentation-file-ref-check
>>>>> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
>>>>> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt
>>>>>
>>>>> As written at boot-image-header.txt, it is waiting for the addition of
>>>>> a future file:
>>>>>
>>>>> 	"The complete booting guide will be available at
>>>>> 	  Documentation/riscv/booting.txt."
>>>>>       
>>>>
>>>> Yeah. We don't have complete booting guide defined in RISC-V land.
>>>> Documentation/riscv/booting.txt will be available once we have that.
>>>>
>>>> In the mean time, do we need to convert boot-image-header.txt to
>>>> boot-image-header.rst and fix the reference to
>>>> Documentation/riscv/booting.rst as well ?
>>>
>>> Well, in the mean time, every time someone builds the Kernel with
>>> COMPILE_TEST enabled, a warning will be produced.
>>>
>>> So, my suggestion would be to write it on a different way, like:
>>>
>>> 	"A complete booting guide is being written and should be
>>> 	 available on future versions."
>>>
>>> Or:
>>> 	TODO:
>>> 	   Write a complete booting guide.
>>>
>>> And update this once the guide is finished. This should be enough
>>> to prevent the warning.
>>>    
>>
>> Sounds good to me.
>>
>>> With regards to converting it to ReST, that's recommended. I suspect
>>> we could be able to finish the entire doc conversion in a couple
>>> Kernel versions.
>>>    
>> Sure.
>>
>>> Also, it should be really trivial to convert this one to ReST.
>>>    
>>
>> Yes. Let me know if you prefer to update it along with your series or I
>> will send the patch.
> 
> I suspect it would be quicker if I write it. I'm sending it in a
> few.
> 
Thanks!!

> Thanks,
> Mauro
> 


-- 
Regards,
Atish

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

* Re: [PATCH] docs: riscv: convert boot-image-header.txt to ReST
  2019-07-26 21:01       ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
@ 2019-07-26 22:24         ` Atish Patra
  2019-07-31 19:02         ` Jonathan Corbet
  1 sibling, 0 replies; 10+ messages in thread
From: Atish Patra @ 2019-07-26 22:24 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Linux Doc Mailing List
  Cc: Albert Ou, Jonathan Corbet, Linus Walleij, Palmer Dabbelt,
	linux-kernel, Mauro Carvalho Chehab, Paul Walmsley, linux-riscv,
	Karsten Merker

On 7/26/19 2:02 PM, Mauro Carvalho Chehab wrote:
> Convert this small file to ReST format by:
>     - Using a proper markup for the document title;
>     - marking a code block as such;
>     - use tags for Author and date;
>     - use tables for bit map fields.
> 
> While here, fix a broken reference for a document with is
> planned but is not here yet.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> ---
>   ...image-header.txt => boot-image-header.rst} | 39 ++++++++++++-------
>   Documentation/riscv/index.rst                 |  1 +
>   2 files changed, 26 insertions(+), 14 deletions(-)
>   rename Documentation/riscv/{boot-image-header.txt => boot-image-header.rst} (72%)
> 
> diff --git a/Documentation/riscv/boot-image-header.txt b/Documentation/riscv/boot-image-header.rst
> similarity index 72%
> rename from Documentation/riscv/boot-image-header.txt
> rename to Documentation/riscv/boot-image-header.rst
> index 1b73fea23b39..43e9bd0731d5 100644
> --- a/Documentation/riscv/boot-image-header.txt
> +++ b/Documentation/riscv/boot-image-header.rst
> @@ -1,22 +1,25 @@
> -				Boot image header in RISC-V Linux
> -			=============================================
> +=================================
> +Boot image header in RISC-V Linux
> +=================================
>   
> -Author: Atish Patra <atish.patra@wdc.com>
> -Date  : 20 May 2019
> +:Author: Atish Patra <atish.patra@wdc.com>
> +:Date:   20 May 2019
>   
>   This document only describes the boot image header details for RISC-V Linux.
> -The complete booting guide will be available at Documentation/riscv/booting.txt.
>   
> -The following 64-byte header is present in decompressed Linux kernel image.
> +TODO:
> +  Write a complete booting guide.
> +
> +The following 64-byte header is present in decompressed Linux kernel image::
>   
>   	u32 code0;		  /* Executable code */
> -	u32 code1; 		  /* Executable code */
> +	u32 code1;		  /* Executable code */
>   	u64 text_offset;	  /* Image load offset, little endian */
>   	u64 image_size;		  /* Effective Image size, little endian */
>   	u64 flags;		  /* kernel flags, little endian */
>   	u32 version;		  /* Version of this header */
> -	u32 res1  = 0;		  /* Reserved */
> -	u64 res2  = 0;    	  /* Reserved */
> +	u32 res1 = 0;		  /* Reserved */
> +	u64 res2 = 0;		  /* Reserved */
>   	u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */
>   	u32 res3;		  /* Reserved for additional RISC-V specific header */
>   	u32 res4;		  /* Reserved for PE COFF offset */
> @@ -25,16 +28,21 @@ This header format is compliant with PE/COFF header and largely inspired from
>   ARM64 header. Thus, both ARM64 & RISC-V header can be combined into one common
>   header in future.
>   
> -Notes:
> +Notes
> +=====
> +
>   - This header can also be reused to support EFI stub for RISC-V in future. EFI
>     specification needs PE/COFF image header in the beginning of the kernel image
>     in order to load it as an EFI application. In order to support EFI stub,
>     code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should
>     point to the rest of the PE/COFF header.
>   
> -- version field indicate header version number.
> -	Bits 0:15  - Minor version
> -	Bits 16:31 - Major version
> +- version field indicate header version number
> +
> +	==========  =============
> +	Bits 0:15   Minor version
> +	Bits 16:31  Major version
> +	==========  =============
>   
>     This preserves compatibility across newer and older version of the header.
>     The current version is defined as 0.1.
> @@ -44,7 +52,10 @@ Notes:
>     extension for RISC-V in future. For current version, it is set to be zero.
>   
>   - In current header, the flag field has only one field.
> -	Bit 0: Kernel endianness. 1 if BE, 0 if LE.
> +
> +	=====  ====================================
> +	Bit 0  Kernel endianness. 1 if BE, 0 if LE.
> +	=====  ====================================
>   
>   - Image size is mandatory for boot loader to load kernel image. Booting will
>     fail otherwise.
> diff --git a/Documentation/riscv/index.rst b/Documentation/riscv/index.rst
> index e3ca0922a8c2..215fd3c1f2d5 100644
> --- a/Documentation/riscv/index.rst
> +++ b/Documentation/riscv/index.rst
> @@ -5,6 +5,7 @@ RISC-V architecture
>   .. toctree::
>       :maxdepth: 1
>   
> +    boot-image-header
>       pmu
>   
>   .. only::  subproject and html
> 

Thanks for the quick patch.

Reviewed-by: Atish Patra <atish.patra@wdc.com>

-- 
Regards,
Atish

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

* Re: [PATCH] docs: riscv: convert boot-image-header.txt to ReST
  2019-07-26 21:01       ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
  2019-07-26 22:24         ` Atish Patra
@ 2019-07-31 19:02         ` Jonathan Corbet
  1 sibling, 0 replies; 10+ messages in thread
From: Jonathan Corbet @ 2019-07-31 19:02 UTC (permalink / raw)
  To: Mauro Carvalho Chehab
  Cc: Linux Doc Mailing List, Mauro Carvalho Chehab, linux-kernel,
	Atish Patra, Paul Walmsley, Palmer Dabbelt, Albert Ou,
	Karsten Merker, Linus Walleij, linux-riscv

On Fri, 26 Jul 2019 18:01:55 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> Convert this small file to ReST format by:
>    - Using a proper markup for the document title;
>    - marking a code block as such;
>    - use tags for Author and date;
>    - use tables for bit map fields.
> 
> While here, fix a broken reference for a document with is
> planned but is not here yet.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

Applied, thanks.

jon

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

* Re: [PATCH 0/7] Fix broken references to files under Documentation/*
       [not found] ` <CGME20190809101313eucas1p1363a5f60c06081bd9b2ef9b45248414f@eucas1p1.samsung.com>
@ 2019-08-09 10:13   ` Łukasz Stelmach
  0 siblings, 0 replies; 10+ messages in thread
From: Łukasz Stelmach @ 2019-08-09 10:13 UTC (permalink / raw)
  To: Rob Herring, Matt Mackall, Herbert Xu
  Cc: Mauro Carvalho Chehab, linux-doc, linux-kernel, Atish Patra,
	Krzysztof Kozlowski

[-- Attachment #1: Type: text/plain, Size: 2503 bytes --]

It was <2019-07-26 pią 13:47>, when Mauro Carvalho Chehab wrote:
> Solves most of the pending broken references upstream, except for two of
> them:
>
> 	$ ./scripts/documentation-file-ref-check 
> 	Documentation/riscv/boot-image-header.txt: Documentation/riscv/booting.txt
> 	MAINTAINERS: Documentation/devicetree/bindings/rng/samsung,exynos5250-trng.txt

Please apply the patch https://patchwork.kernel.org/patch/10758009/

> As written at boot-image-header.txt, it is waiting for the addition of
> a future file: 
>
> 	"The complete booting guide will be available at
> 	  Documentation/riscv/booting.txt."
>
> The second is due to this patch, pending to be merged:
> 	https://lore.kernel.org/patchwork/patch/994210/
>
> I'm not a DT expert, but I can't see any issue with this patch, except
> for a missing acked-by a DT maintainer, and a possible conversion to
> yaml. IMO, the best fix for this would be to merge the DT patch.
>
> Patch 1 was already submitted before, together with the v1 of
> my PDF fix series.
>
> Mauro Carvalho Chehab (7):
>   docs: fix broken doc references due to renames
>   docs: generic-counter.rst: fix broken references for ABI file
>   MAINTAINERS: fix reference to net phy ABI file
>   MAINTAINERS: fix a renamed DT reference
>   docs: cgroup-v1/blkio-controller.rst: remove a CFQ left over
>   docs: zh_CN: howto.rst: fix a broken reference
>   docs: dt: fix a sound binding broken reference
>
>  Documentation/RCU/rculist_nulls.txt                |  2 +-
>  .../admin-guide/cgroup-v1/blkio-controller.rst     |  6 ------
>  .../devicetree/bindings/arm/idle-states.txt        |  2 +-
>  .../devicetree/bindings/sound/sun8i-a33-codec.txt  |  2 +-
>  Documentation/driver-api/generic-counter.rst       |  4 ++--
>  Documentation/locking/spinlocks.rst                |  4 ++--
>  Documentation/memory-barriers.txt                  |  2 +-
>  .../translations/ko_KR/memory-barriers.txt         |  2 +-
>  Documentation/translations/zh_CN/process/howto.rst |  2 +-
>  Documentation/watchdog/hpwdt.rst                   |  2 +-
>  MAINTAINERS                                        | 14 +++++++-------
>  drivers/gpu/drm/drm_modes.c                        |  2 +-
>  drivers/i2c/busses/i2c-nvidia-gpu.c                |  2 +-
>  drivers/scsi/hpsa.c                                |  4 ++--
>  14 files changed, 22 insertions(+), 28 deletions(-)

-- 
Łukasz Stelmach
Samsung R&D Institute Poland
Samsung Electronics

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 487 bytes --]

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

end of thread, other threads:[~2019-08-09 10:13 UTC | newest]

Thread overview: 10+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-07-26 11:47 [PATCH 0/7] Fix broken references to files under Documentation/* Mauro Carvalho Chehab
2019-07-26 19:55 ` Atish Patra
2019-07-26 20:13   ` Mauro Carvalho Chehab
2019-07-26 20:18     ` Atish Patra
2019-07-26 21:01       ` Mauro Carvalho Chehab
2019-07-26 22:16         ` Atish Patra
2019-07-26 21:01       ` [PATCH] docs: riscv: convert boot-image-header.txt to ReST Mauro Carvalho Chehab
2019-07-26 22:24         ` Atish Patra
2019-07-31 19:02         ` Jonathan Corbet
     [not found] ` <CGME20190809101313eucas1p1363a5f60c06081bd9b2ef9b45248414f@eucas1p1.samsung.com>
2019-08-09 10:13   ` [PATCH 0/7] Fix broken references to files under Documentation/* Łukasz Stelmach

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).