All of lore.kernel.org
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: [PATCH v3 02/10] docs: copy only the command from a console block
Date: Thu, 24 Sep 2026 13:28:45 -0400	[thread overview]
Message-ID: <20260924172853.2665062-3-twoerner@gmail.com> (raw)
In-Reply-To: <20260924172853.2665062-1-twoerner@gmail.com>

The copy button matches the literal "$ " prompt, so on a block prompted
any other way it matches nothing and falls back to copying every line,
prompt, and output included. Match a pattern covering each prompt shape
the manuals use instead, so the button gives the command alone whatever
the prompt looks like.

AI-Generated: codex/claude-opus 5 (xhigh)
Signed-off-by: Trevor Woerner <twoerner@gmail.com>
---
changes in v3:
- the comment is shorter and no longer contradicts itself about scope
- a ">>> " alternative covers the one Python interpreter example
- a "(gdb) " alternative. The console lexer already marks that prompt,
  so a selection skipped it while the button copied it; the two now
  agree

changes in v2:
- dropped the stylesheet change, so a mouse selection keeps the output
- the comment now says this governs the copy button only, and only
  reaches a block the console lexer has read
---
 documentation/conf.py | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/documentation/conf.py b/documentation/conf.py
index 48d28a686807..d2252d5ab966 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -242,4 +242,21 @@ intersphinx_mapping = {
 # -- sphinx_copybutton configuration -----------------------------------------
 
 # sphinx-copybutton configuration
-copybutton_prompt_text = "$ "
+# Applies to the copy button only; a mouse selection is untouched.
+# Not scoped to console blocks, so every alternative has to be safe in a
+# BitBake or configuration example too.
+# No rule for a bare "#": it opens a comment, a root prompt, and a
+# line of program output alike.
+copybutton_prompt_text = "|".join((
+    r"^(?:\S+[@:]\S*)?\$\s+",   # "$ ", and "user@host:~$ "
+    r"^\S+[@:]\S*#\s+",         # "root@machine:~# ", a root prompt
+    r"^[A-Za-z]:\\[^>]*>\s*",   # "C:\WINDOWS\system32>", cmd.exe
+    r"^DISKPART>\s*",           # diskpart prints a prompt of its own
+    r"^pydevshell>\s+",         # bitbake -c pydevshell
+    r"^>>> ",                   # a Python interpreter session
+    r"^\(gdb\)\s+",             # a gdb session
+))
+copybutton_prompt_is_regexp = True
+copybutton_only_copy_prompt_lines = True
+copybutton_remove_prompts = True
+copybutton_line_continuation_character = "\\"
-- 
2.50.0.173.g8b6f19ccfc3a



  parent reply	other threads:[~2026-09-24 17:29 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-09-24 17:28 [PATCH v3 00/10] docs: editorial repairs to the examples Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 01/10] docs: give the root prompts a preamble Trevor Woerner
2026-09-24 17:28 ` Trevor Woerner [this message]
2026-09-24 17:28 ` [PATCH v3 03/10] docs: show a prompt on commands the reader is meant to type Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 04/10] docs: write an elided passage as a comment Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 05/10] docs: mark the placeholders in examples Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 06/10] docs: remove real accounts from the examples Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 07/10] kernel-dev: give each example block one thing to hold Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 08/10] ref-manual: put the ARCHIVER_MODE comments on their own lines Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 09/10] ref-manual: drop "partition" as a wic kickstart command Trevor Woerner
2026-09-24 17:28 ` [PATCH v3 10/10] dev-manual: indent a list continuation so the code block ends Trevor Woerner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20260924172853.2665062-3-twoerner@gmail.com \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.