[PATCH 3/3] docs: Add prompt to clone commands

Andrea Bolognani via Devel posted 3 patches 3 months ago
[PATCH 3/3] docs: Add prompt to clone commands
Posted by Andrea Bolognani via Devel 3 months ago
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
Re: [PATCH 3/3] docs: Add prompt to clone commands
Posted by Peter Krempa via Devel 3 months ago
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>
Re: [PATCH 3/3] docs: Add prompt to clone commands
Posted by Andrea Bolognani via Devel 3 months ago
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