docs: Correct name for xen-command-line.pandoc

[PATCH] docs: Correct name for xen-command-line.pandoc

Posted by Leo Yan 2 years, 6 months ago

In the commit d661611d08 ("docs/markdown: Switch to using pandoc, and
fix underscore escaping"), the documentation suffix was changed from
".markdown" to ".pandoc"; however, the reference was missed to update.

This patch updates the documentation name to xen-command-line.pandoc.

Fixes: d661611d08 ("docs/markdown: Switch to using pandoc, and fix underscore escaping")
Signed-off-by: Leo Yan <leo.yan@linaro.org>
---
 docs/features/sched_credit2.pandoc | 2 +-
 docs/misc/arm/big.LITTLE.txt       | 2 +-
 xen/common/Kconfig                 | 2 +-
 3 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/docs/features/sched_credit2.pandoc b/docs/features/sched_credit2.pandoc
index 436ff9f8f6..ef07e463cb 100644
--- a/docs/features/sched_credit2.pandoc
+++ b/docs/features/sched_credit2.pandoc
@@ -27,7 +27,7 @@ different than `credit2`) parameter is passed to Xen via the
 bootloader.
 
 Other parameters are available for tuning the behavior of Credit2
-(see `docs/misc/xen-command-line.markdown` for a complete list and
+(see `docs/misc/xen-command-line.pandoc` for a complete list and
 for their meaning).
 
 Once the system is live, for creating a cpupool with Credit2 as
diff --git a/docs/misc/arm/big.LITTLE.txt b/docs/misc/arm/big.LITTLE.txt
index b6ea1c9d61..1d11058444 100644
--- a/docs/misc/arm/big.LITTLE.txt
+++ b/docs/misc/arm/big.LITTLE.txt
@@ -42,5 +42,5 @@ The following option runs one domain vcpu as big and one as LITTLE:
   cpus = ["0-3", "4-7"]
 
 
-[1] docs/misc/xen-command-line.markdown
+[1] docs/misc/xen-command-line.pandoc
 [2] docs/man/xl.cfg.pod.5
diff --git a/xen/common/Kconfig b/xen/common/Kconfig
index dd8d7c3f1c..0d248ab941 100644
--- a/xen/common/Kconfig
+++ b/xen/common/Kconfig
@@ -440,7 +440,7 @@ config DOM0_MEM
 	  The specified string will be used for the dom0_mem parameter in
 	  case it was not specified on the command line.
 
-	  See docs/misc/xen-command-line.markdown for the supported syntax.
+	  See docs/misc/xen-command-line.pandoc for the supported syntax.
 
 	  Leave empty if you are not sure what to specify.
 
-- 
2.39.2

Re: [PATCH] docs: Correct name for xen-command-line.pandoc

Posted by Stefano Stabellini 2 years, 6 months ago

On Mon, 24 Jul 2023, Leo Yan wrote:
> In the commit d661611d08 ("docs/markdown: Switch to using pandoc, and
> fix underscore escaping"), the documentation suffix was changed from
> ".markdown" to ".pandoc"; however, the reference was missed to update.
> 
> This patch updates the documentation name to xen-command-line.pandoc.
> 
> Fixes: d661611d08 ("docs/markdown: Switch to using pandoc, and fix underscore escaping")
> Signed-off-by: Leo Yan <leo.yan@linaro.org>

Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>


> ---
>  docs/features/sched_credit2.pandoc | 2 +-
>  docs/misc/arm/big.LITTLE.txt       | 2 +-
>  xen/common/Kconfig                 | 2 +-
>  3 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/docs/features/sched_credit2.pandoc b/docs/features/sched_credit2.pandoc
> index 436ff9f8f6..ef07e463cb 100644
> --- a/docs/features/sched_credit2.pandoc
> +++ b/docs/features/sched_credit2.pandoc
> @@ -27,7 +27,7 @@ different than `credit2`) parameter is passed to Xen via the
>  bootloader.
>  
>  Other parameters are available for tuning the behavior of Credit2
> -(see `docs/misc/xen-command-line.markdown` for a complete list and
> +(see `docs/misc/xen-command-line.pandoc` for a complete list and
>  for their meaning).
>  
>  Once the system is live, for creating a cpupool with Credit2 as
> diff --git a/docs/misc/arm/big.LITTLE.txt b/docs/misc/arm/big.LITTLE.txt
> index b6ea1c9d61..1d11058444 100644
> --- a/docs/misc/arm/big.LITTLE.txt
> +++ b/docs/misc/arm/big.LITTLE.txt
> @@ -42,5 +42,5 @@ The following option runs one domain vcpu as big and one as LITTLE:
>    cpus = ["0-3", "4-7"]
>  
>  
> -[1] docs/misc/xen-command-line.markdown
> +[1] docs/misc/xen-command-line.pandoc
>  [2] docs/man/xl.cfg.pod.5
> diff --git a/xen/common/Kconfig b/xen/common/Kconfig
> index dd8d7c3f1c..0d248ab941 100644
> --- a/xen/common/Kconfig
> +++ b/xen/common/Kconfig
> @@ -440,7 +440,7 @@ config DOM0_MEM
>  	  The specified string will be used for the dom0_mem parameter in
>  	  case it was not specified on the command line.
>  
> -	  See docs/misc/xen-command-line.markdown for the supported syntax.
> +	  See docs/misc/xen-command-line.pandoc for the supported syntax.
>  
>  	  Leave empty if you are not sure what to specify.
>  
> -- 
> 2.39.2
>