[PATCH 0/3] docs: Small tweaks to downloads page
*** CLICK HERE TO BLURB *** Andrea Bolognani (3): docs: Unify clone instructions docs: Drop mention of read-only git mirrors docs: Add prompt to clone commands docs/downloads.rst | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) -- 2.49.0
We use the same format for GitLab and libvirt.org, but not for GitHub. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/downloads.rst b/docs/downloads.rst index 00feb8a761..11837c29e1 100644 --- a/docs/downloads.rst +++ b/docs/downloads.rst @@ -326,7 +326,7 @@ repositories on GitHub: :: - https://github.com/libvirt/ + git clone https://github.com/libvirt/[module name].git And there are also read-only mirrors on libvirt.org: -- 2.49.0
On Thu, Jun 05, 2025 at 15:39:13 +0200, Andrea Bolognani via Devel wrote:
We use the same format for GitLab and libvirt.org, but not for GitHub.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
These mirrors no longer exist, they're just straight up redirects to GitLab now. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/downloads.rst b/docs/downloads.rst index 11837c29e1..cdcddabc57 100644 --- a/docs/downloads.rst +++ b/docs/downloads.rst @@ -328,12 +328,6 @@ repositories on GitHub: git clone https://github.com/libvirt/[module name].git -And there are also read-only mirrors on libvirt.org: - -:: - - git clone https://libvirt.org/git/[module name].git - Note that for most repositories, development happens via merge requests on GitLab. However, for the main `libvirt.git` repository all patch review and discussion only occurs on the `devel <contact.html>`__ mailing list. -- 2.49.0
On Thu, Jun 05, 2025 at 15:39:14 +0200, Andrea Bolognani via Devel wrote:
These mirrors no longer exist, they're just straight up redirects to GitLab now.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 6 ------ 1 file changed, 6 deletions(-)
Reviewed-by: Peter Krempa <pkrempa@redhat.com>
Looks slightly nicer and makes it absolutely obvious that these are shell commands. Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/downloads.rst b/docs/downloads.rst index cdcddabc57..e39d876f36 100644 --- a/docs/downloads.rst +++ b/docs/downloads.rst @@ -319,14 +319,14 @@ Each module can be cloned anonymously using: :: - git clone https://gitlab.com/libvirt/[module name].git + $ git clone https://gitlab.com/libvirt/[module name].git In addition to this primary repository, there are mirrored read-only git repositories on GitHub: :: - git clone https://github.com/libvirt/[module name].git + $ git clone https://github.com/libvirt/[module name].git Note that for most repositories, development happens via merge requests on GitLab. However, for the main `libvirt.git` repository all patch review and -- 2.49.0
On Thu, Jun 05, 2025 at 15:39:15 +0200, Andrea Bolognani via Devel wrote:
Looks slightly nicer and makes it absolutely obvious that these are shell commands.
Signed-off-by: Andrea Bolognani <abologna@redhat.com> --- docs/downloads.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/downloads.rst b/docs/downloads.rst index cdcddabc57..e39d876f36 100644 --- a/docs/downloads.rst +++ b/docs/downloads.rst @@ -319,14 +319,14 @@ Each module can be cloned anonymously using:
::
- git clone https://gitlab.com/libvirt/[module name].git + $ git clone https://gitlab.com/libvirt/[module name].git
In addition to this primary repository, there are mirrored read-only git repositories on GitHub:
::
- git clone https://github.com/libvirt/[module name].git + $ git clone https://github.com/libvirt/[module name].git
Note that for most repositories, development happens via merge requests on GitLab. However, for the main `libvirt.git` repository all patch review and
I'm not a fan. The rendered HTML makes it obvious by putting it in a block with different formatting. With the $ in front you can't tripple click to select the whole line and paste it somewhere. But since the command itself isn't usable without editing anyways I guess my point isn't entirely sound here. Decide as you like Reviewed-by: Peter Krempa <pkrempa@redhat.com>
On Thu, Jun 05, 2025 at 05:13:23PM +0200, Peter Krempa wrote:
I'm not a fan. The rendered HTML makes it obvious by putting it in a block with different formatting.
With the $ in front you can't tripple click to select the whole line and paste it somewhere.
But since the command itself isn't usable without editing anyways I guess my point isn't entirely sound here.
Decide as you like
I made this a separate commit specifically in case people weren't thrilled about the change. I'll skip it. -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani -
Peter Krempa