appdev-guide/Connections: Remove duplicated entries

[libvirt] [PATCH] appdev-guide/Connections: Remove duplicated entries

Posted by Marcos Paulo de Souza 5 years, 10 months ago

Both /hosts/cpu/arch and /hosts/cpu/features appear twice in the documentation.

Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
---

 This is my first submission to libvirt, so let me know if I forgot something.

 en-US/Connections.xml | 11 -----------
 1 file changed, 11 deletions(-)

diff --git a/en-US/Connections.xml b/en-US/Connections.xml
index 96fe011..d7b6af6 100644
--- a/en-US/Connections.xml
+++ b/en-US/Connections.xml
@@ -963,17 +963,6 @@ int main(int argc, char *argv[])
       CPU architecture.  As of this writing, all libvirt drivers initialize this
       from the output of uname(2).
     </para>
-    <para>
-      <literal>/host/cpu/features</literal> is an optional sub-document that describes additional cpu
-      features present on the host.  As of this writing, it is only used by the
-      xen driver to report on the presence or lack of the svm or vmx flag, and to
-      report on the presence or lack of the pae flag.
-    </para>
-    <para>
-      <literal>/host/cpu/arch</literal> is a required XML node that describes the underlying
-      host CPU architecture. As of this writing, all libvirt drivers
-      initialize this from the output of uname(2).
-    </para>
     <para>
       <literal>/host/cpu/model</literal> is an optional element that describes the CPU model
       that the host CPUs most closely resemble.  The list of CPU models
-- 
2.17.1

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] appdev-guide/Connections: Remove duplicated entries

Posted by Erik Skultety 5 years, 10 months ago

On Sat, Jun 23, 2018 at 11:32:55AM -0300, Marcos Paulo de Souza wrote:
> Both /hosts/cpu/arch and /hosts/cpu/features appear twice in the documentation.
>
> Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
> ---
>
>  This is my first submission to libvirt, so let me know if I forgot something.

Which repo is this patch against?

Erik

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] appdev-guide/Connections: Remove duplicated entries

Posted by Marcos Paulo de Souza 5 years, 10 months ago

On Mon, Jun 25, 2018 at 01:35:33PM +0200, Erik Skultety wrote:
> On Sat, Jun 23, 2018 at 11:32:55AM -0300, Marcos Paulo de Souza wrote:
> > Both /hosts/cpu/arch and /hosts/cpu/features appear twice in the documentation.
> >
> > Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
> > ---
> >
> >  This is my first submission to libvirt, so let me know if I forgot something.
> 
> Which repo is this patch against?

This patch is againt the appdev-guide located here:
https://libvirt.org/git/?p=libvirt-appdev-guide.git;a=summary

The repository seems to be the source of the documenation located in
libvirt.org:
https://libvirt.org/devguide.html

Is there other place to send patches for appdev-guide?

> 
> Erik

-- 
Thanks,
	Marcos

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] appdev-guide/Connections: Remove duplicated entries

Posted by Erik Skultety 5 years, 10 months ago

On Fri, Jun 22, 2018 at 05:44:18PM -0300, Marcos Paulo de Souza wrote:
> On Mon, Jun 25, 2018 at 01:35:33PM +0200, Erik Skultety wrote:
> > On Sat, Jun 23, 2018 at 11:32:55AM -0300, Marcos Paulo de Souza wrote:
> > > Both /hosts/cpu/arch and /hosts/cpu/features appear twice in the documentation.
> > >
> > > Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
> > > ---
> > >
> > >  This is my first submission to libvirt, so let me know if I forgot something.
> >
> > Which repo is this patch against?
>
> This patch is againt the appdev-guide located here:
> https://libvirt.org/git/?p=libvirt-appdev-guide.git;a=summary
>
> The repository seems to be the source of the documenation located in
> libvirt.org:
> https://libvirt.org/devguide.html
>
> Is there other place to send patches for appdev-guide?

No, but usually we change patch subject prefix to PATCH-project so that it's
obvious which project you're sending the patch against, because from the commit
subject itself it's not apparent at first sight, especially when noone has
touched that git for over 6 years. The document itself was never even finished
and regarding the publican we basically it by moving the static content to the
main repo. Anyhow, I'm fairly sceptical anyone ever used the development guide
solely because of how much it's missing, so I don't know how much sense it makes
to push the patch and whether we keep building the repo so that the change
would actually be propagated, even though it's correct, but Dan will know the
answer for sure, so I'm CCing him.

Erik

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] appdev-guide/Connections: Remove duplicated entries

Posted by Marcos Paulo de Souza 5 years, 10 months ago

On Mon, Jun 25, 2018 at 05:13:26PM +0200, Erik Skultety wrote:
> On Fri, Jun 22, 2018 at 05:44:18PM -0300, Marcos Paulo de Souza wrote:
> > On Mon, Jun 25, 2018 at 01:35:33PM +0200, Erik Skultety wrote:
> > > On Sat, Jun 23, 2018 at 11:32:55AM -0300, Marcos Paulo de Souza wrote:
> > > > Both /hosts/cpu/arch and /hosts/cpu/features appear twice in the documentation.
> > > >
> > > > Signed-off-by: Marcos Paulo de Souza <marcos.souza.org@gmail.com>
> > > > ---
> > > >
> > > >  This is my first submission to libvirt, so let me know if I forgot something.
> > >
> > > Which repo is this patch against?
> >
> > This patch is againt the appdev-guide located here:
> > https://libvirt.org/git/?p=libvirt-appdev-guide.git;a=summary
> >
> > The repository seems to be the source of the documenation located in
> > libvirt.org:
> > https://libvirt.org/devguide.html
> >
> > Is there other place to send patches for appdev-guide?
> 
> No, but usually we change patch subject prefix to PATCH-project so that it's
> obvious which project you're sending the patch against, because from the commit
> subject itself it's not apparent at first sight, especially when noone has
> touched that git for over 6 years. The document itself was never even finished
> and regarding the publican we basically it by moving the static content to the
> main repo. Anyhow, I'm fairly sceptical anyone ever used the development guide
> solely because of how much it's missing, so I don't know how much sense it makes
> to push the patch and whether we keep building the repo so that the change
> would actually be propagated, even though it's correct, but Dan will know the
> answer for sure, so I'm CCing him.

OK, fair enough. As I saw a commit in the last months, I tought it would be good
to improve it. But OK, I will try to read the docs from the main repo, thanks
for pointing it out.

Maybe it would be nice to state this in the libvirt.org.

Thanks,

> 
> Erik

-- 
Thanks,
	Marcos

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list