diff mbox

[Xen-devel,for,4.5] docs/man: xl.pod.1: Fix build issue after commit 7471879

Message ID 1413663721-30141-1-git-send-email-julien.grall@linaro.org
State Accepted, archived
Headers show

Commit Message

Julien Grall Oct. 18, 2014, 8:22 p.m. UTC
The commit 7471879 "tools: CMDs and APIs for Cache Monitoring Technology"
has introduced a new section but forgot to add '=back'. This will result
a build issue with newer podman:

man/xl.pod.1 around line 1443: You forgot a '=back' before '=head1'

or creating a section "POD ERRORS" with older one.

At the same time, capitalize the title of the section to match the coding
style used within the files.

Signed-off-by: Julien Grall <julien.grall@linaro.org>
---
    This is a bug fix for Xen 4.5. Some version of podman throws an error
when the pod files is malformed and therefore make the build aborts.

    This is prevent to build Xen within Linaro CI Loop.
---
 docs/man/xl.pod.1 |    4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Wei Liu Oct. 19, 2014, 12:40 p.m. UTC | #1
On Sat, Oct 18, 2014 at 09:22:01PM +0100, Julien Grall wrote:
> The commit 7471879 "tools: CMDs and APIs for Cache Monitoring Technology"
> has introduced a new section but forgot to add '=back'. This will result
> a build issue with newer podman:
> 
> man/xl.pod.1 around line 1443: You forgot a '=back' before '=head1'
> 
> or creating a section "POD ERRORS" with older one.
> 
> At the same time, capitalize the title of the section to match the coding
> style used within the files.
> 
> Signed-off-by: Julien Grall <julien.grall@linaro.org>

Acked-by: Wei Liu <wei.liu2@citrix.com>

> ---
>     This is a bug fix for Xen 4.5. Some version of podman throws an error
> when the pod files is malformed and therefore make the build aborts.
> 
>     This is prevent to build Xen within Linaro CI Loop.
> ---
>  docs/man/xl.pod.1 |    4 +++-
>  1 file changed, 3 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
> index 925cd7d..adc9f56 100644
> --- a/docs/man/xl.pod.1
> +++ b/docs/man/xl.pod.1
> @@ -1440,7 +1440,9 @@ Load FLASK policy from the given policy file. The initial policy is provided to
>  the hypervisor as a multiboot module; this command allows runtime updates to the
>  policy. Loading new security policy will reset runtime changes to device labels.
>  
> -=head1 Cache Monitoring Technology
> +=back
> +
> +=head1 CACHE MONITORING TECHNOLOGY
>  
>  Intel Haswell and later server platforms offer monitoring capability in each
>  logical processor to measure specific platform shared resource metric, for
> -- 
> 1.7.10.4
> 
> 
> _______________________________________________
> Xen-devel mailing list
> Xen-devel@lists.xen.org
> http://lists.xen.org/xen-devel
Ian Campbell Oct. 20, 2014, 1:20 p.m. UTC | #2
On Sun, 2014-10-19 at 13:40 +0100, Wei Liu wrote:
> On Sat, Oct 18, 2014 at 09:22:01PM +0100, Julien Grall wrote:
> > The commit 7471879 "tools: CMDs and APIs for Cache Monitoring Technology"
> > has introduced a new section but forgot to add '=back'. This will result
> > a build issue with newer podman:
> > 
> > man/xl.pod.1 around line 1443: You forgot a '=back' before '=head1'
> > 
> > or creating a section "POD ERRORS" with older one.
> > 
> > At the same time, capitalize the title of the section to match the coding
> > style used within the files.
> > 
> > Signed-off-by: Julien Grall <julien.grall@linaro.org>
> 
> Acked-by: Wei Liu <wei.liu2@citrix.com>

Likewise + applied.

Jan, you mentioned that some markdown stuff was looking odd to you last
week -- could have been this?

Ian.
diff mbox

Patch

diff --git a/docs/man/xl.pod.1 b/docs/man/xl.pod.1
index 925cd7d..adc9f56 100644
--- a/docs/man/xl.pod.1
+++ b/docs/man/xl.pod.1
@@ -1440,7 +1440,9 @@  Load FLASK policy from the given policy file. The initial policy is provided to
 the hypervisor as a multiboot module; this command allows runtime updates to the
 policy. Loading new security policy will reset runtime changes to device labels.
 
-=head1 Cache Monitoring Technology
+=back
+
+=head1 CACHE MONITORING TECHNOLOGY
 
 Intel Haswell and later server platforms offer monitoring capability in each
 logical processor to measure specific platform shared resource metric, for