[libvirt PATCH 0/2] CONTRIBUTING: Clean up and improve
Andrea Bolognani (2): CONTRIBUTING: Indent command by three spaces CONTRIBUTING: Include note about build system tools CONTRIBUTING.rst | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) -- 2.25.4
This is the proper way to do it according to our reStructuredText style guidelines. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f476700fdd..12b6e3f0e8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -12,9 +12,9 @@ your git clone run: :: - $ mkdir build && cd build - $ ../autogen.sh - $ make + $ mkdir build && cd build + $ ../autogen.sh + $ make You'll find the freshly-built document in ``docs/contribute.html``. @@ -23,13 +23,13 @@ up your system by calling :: - $ sudo dnf builddep libvirt + $ sudo dnf builddep libvirt if you're on a RHEL-based distribution or :: - $ sudo apt-get build-dep libvirt + $ sudo apt-get build-dep libvirt if you're on a Debian-based one. -- 2.25.4
On Mon, Apr 27, 2020 at 12:54:20PM +0200, Andrea Bolognani wrote:
This is the proper way to do it according to our reStructuredText style guidelines.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
Debian always runs autoreconf at package build time, which means that apt-get build-dep will bring in everything that's needed to build libvirt from a git clone; Fedora and RHEL, however, skip this step, so we have to install some extra packages manually. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 12b6e3f0e8..32829b1d96 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -33,6 +33,15 @@ if you're on a RHEL-based distribution or if you're on a Debian-based one. +Note that, for the RHEL-based case, if you're on a machine where you +haven't done any C development before, you will probably also need +to run + +:: + + $ sudo dnf groupinstall "C Development Tools and Libraries" + $ sudo dnf install rpm-build + You might still be missing some dependencies if your distribution is shipping an old libvirt version, but that will get you much closer to where you need to be to build successfully from source. -- 2.25.4
On Mon, Apr 27, 2020 at 12:54:21PM +0200, Andrea Bolognani wrote:
Debian always runs autoreconf at package build time, which means that apt-get build-dep will bring in everything that's needed to build libvirt from a git clone; Fedora and RHEL, however, skip this step, so we have to install some extra packages manually.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- CONTRIBUTING.rst | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 12b6e3f0e8..32829b1d96 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -33,6 +33,15 @@ if you're on a RHEL-based distribution or
if you're on a Debian-based one.
+Note that, for the RHEL-based case, if you're on a machine where you +haven't done any C development before, you will probably also need +to run + +:: + + $ sudo dnf groupinstall "C Development Tools and Libraries"
This group doesn't exist on any RHEL distro, and dnf itself only exists in RHEL >= 8. I htink we should be just listing the packages we need explicitly rather than relying on a group whose name & contents change over time.
+ $ sudo dnf install rpm-build + You might still be missing some dependencies if your distribution is shipping an old libvirt version, but that will get you much closer to where you need to be to build successfully from source.
Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On Mon, 2020-04-27 at 12:03 +0100, Daniel P. Berrangé wrote:
On Mon, Apr 27, 2020 at 12:54:21PM +0200, Andrea Bolognani wrote:
+Note that, for the RHEL-based case, if you're on a machine where you +haven't done any C development before, you will probably also need +to run + +:: + + $ sudo dnf groupinstall "C Development Tools and Libraries"
This group doesn't exist on any RHEL distro, and dnf itself only exists in RHEL >= 8. I htink we should be just listing the packages we need explicitly rather than relying on a group whose name & contents change over time.
I expect most people doing development work on libvirt are using Fedora rather than RHEL, and I really don't want this document to become too verbose or duplicate too much information that's already available elsewhere... If we can cover ~90% of potential users with just a few commands, I think that's preferable. -- Andrea Bolognani / Red Hat / Virtualization
On Mon, Apr 27, 2020 at 01:15:08PM +0200, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:03 +0100, Daniel P. Berrangé wrote:
On Mon, Apr 27, 2020 at 12:54:21PM +0200, Andrea Bolognani wrote:
+Note that, for the RHEL-based case, if you're on a machine where you +haven't done any C development before, you will probably also need +to run + +:: + + $ sudo dnf groupinstall "C Development Tools and Libraries"
This group doesn't exist on any RHEL distro, and dnf itself only exists in RHEL >= 8. I htink we should be just listing the packages we need explicitly rather than relying on a group whose name & contents change over time.
I expect most people doing development work on libvirt are using Fedora rather than RHEL, and I really don't want this document to become too verbose or duplicate too much information that's already available elsewhere... If we can cover ~90% of potential users with just a few commands, I think that's preferable.
Just listing the extra packages is simpler than the group name. dnf install gcc make automake libtool autoconf rpm-build Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On Mon, 2020-04-27 at 12:19 +0100, Daniel P. Berrangé wrote:
On Mon, Apr 27, 2020 at 01:15:08PM +0200, Andrea Bolognani wrote:
I expect most people doing development work on libvirt are using Fedora rather than RHEL, and I really don't want this document to become too verbose or duplicate too much information that's already available elsewhere... If we can cover ~90% of potential users with just a few commands, I think that's preferable.
Just listing the extra packages is simpler than the group name.
dnf install gcc make automake libtool autoconf rpm-build
Point taken, the list is short and unlikely to change much. Can I have your Reviewed-by for the series if I squash your version in? -- Andrea Bolognani / Red Hat / Virtualization
On Mon, 2020-04-27 at 14:01 +0200, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:19 +0100, Daniel P. Berrangé wrote:
Just listing the extra packages is simpler than the group name.
dnf install gcc make automake libtool autoconf rpm-build
Point taken, the list is short and unlikely to change much.
Can I have your Reviewed-by for the series if I squash your version in?
So, does that sound like a plan? I'd rather not have this very simple documentation patch linger on the list for too long :) -- Andrea Bolognani / Red Hat / Virtualization
On Wed, 2020-04-29 at 10:43 +0200, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 14:01 +0200, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:19 +0100, Daniel P. Berrangé wrote:
Just listing the extra packages is simpler than the group name.
dnf install gcc make automake libtool autoconf rpm-build
Point taken, the list is short and unlikely to change much.
Can I have your Reviewed-by for the series if I squash your version in?
So, does that sound like a plan? I'd rather not have this very simple documentation patch linger on the list for too long :)
ping -- Andrea Bolognani / Red Hat / Virtualization
On Mon, Apr 27, 2020 at 02:01:44PM +0200, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:19 +0100, Daniel P. Berrangé wrote:
On Mon, Apr 27, 2020 at 01:15:08PM +0200, Andrea Bolognani wrote:
I expect most people doing development work on libvirt are using Fedora rather than RHEL, and I really don't want this document to become too verbose or duplicate too much information that's already available elsewhere... If we can cover ~90% of potential users with just a few commands, I think that's preferable.
Just listing the extra packages is simpler than the group name.
dnf install gcc make automake libtool autoconf rpm-build
Point taken, the list is short and unlikely to change much.
Can I have your Reviewed-by for the series if I squash your version in?
Yep, with that change added Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> And this is fine for freeze. Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On 4/27/20 1:15 PM, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:03 +0100, Daniel P. Berrangé wrote:
On Mon, Apr 27, 2020 at 12:54:21PM +0200, Andrea Bolognani wrote:
+Note that, for the RHEL-based case, if you're on a machine where you +haven't done any C development before, you will probably also need +to run + +:: + + $ sudo dnf groupinstall "C Development Tools and Libraries"
This group doesn't exist on any RHEL distro, and dnf itself only exists in RHEL >= 8. I htink we should be just listing the packages we need explicitly rather than relying on a group whose name & contents change over time.
I expect most people doing development work on libvirt are using Fedora rather than RHEL,
I beg to differ :-) But my distro will install all build dependencies when I want to install libvirt anyways, so good enough for me. Michal
On Mon, 2020-04-27 at 14:05 +0200, Michal Privoznik wrote:
On 4/27/20 1:15 PM, Andrea Bolognani wrote:
On Mon, 2020-04-27 at 12:03 +0100, Daniel P. Berrangé wrote:
This group doesn't exist on any RHEL distro, and dnf itself only exists in RHEL >= 8. I htink we should be just listing the packages we need explicitly rather than relying on a group whose name & contents change over time.
I expect most people doing development work on libvirt are using Fedora rather than RHEL,
I beg to differ :-)
So you use RHEL for libvirt development? -- Andrea Bolognani / Red Hat / Virtualization
participants (3)
-
Andrea Bolognani -
Daniel P. Berrangé -
Michal Privoznik