diff mbox series

[bug#78463,2/2] news: Add news entry for new 'guix refresh' partial version syntax.

Message ID 8aa67bae95d15ef84334f56386501aba3fa8c25f.1747460420.git.maxim.cournoyer@gmail.com
State New
Headers
Series [bug#78462,1/2] refresh: Allow specifying a partial version via the version specification. |

Commit Message

Maxim Cournoyer May 17, 2025, 5:40 a.m. UTC 
* etc/news.scm (channels-news): New entry.

Change-Id: Ic3be1bd62b4dc36a45fcbb1ae87c8a9bf0b837e9
---
 etc/news.scm | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

pelzflorian (Florian Pelz) May 18, 2025, 2:43 p.m. UTC | #1 
A good change (untested).

It is not appropriate to write XXX: in comments on your first
patch’s unit tests, as I understand the Wiktionary definition of XXX:

2. (computing) Used as a placeholder in source code to mark that some work
still has to be done.


Could you add this German translation?
Additionally, I surrounded the info command in @command{} markup in the
last line of the English news, too.
(title
         (en "@samp{guix refresh} can now target partial versions")
         (de "@samp{guix refresh} kann jetzt unvollständige Versionen als Ziel
nehmen"))
        (body
         (en "While it had been possible for some time to use the
@option{--target-version} to update to a partially defined version, this can
now be more conveniently expressed via the package version specification
directly, by prefixing it with the tilde (@samp{~}) character:

@example
$ guix refresh bash=~5.2
gnu/packages/bash.scm:150:15: bash would be upgraded from 5.1.16 to 5.2.37
@end example

For more information, see @command{info \"(guix) Invoking guix refresh\"}.")
                  (de "Es war schon einige Zeit möglich, unter Angabe von
@option{--target-version} auf eine unvollständig definierte Version zu
aktualisieren; das lässt sich jetzt angenehmer ausdrücken, direkt in der
Paketversionsangabe, wenn Sie ihr das Tildezeichen (@samp{~}) voranstellen:

@example
$ guix refresh bash=~5.2
gnu/packages/bash.scm:150:15: bash würde von 5.1.16 auf 5.2.37 aktualisiert
@end example

Für mehr Informationen siehe @command{info \"(guix.de)Aufruf von guix
refresh\"}.")))
Regards,
Florian
Maxim Cournoyer May 19, 2025, 1:10 a.m. UTC | #2 
Hi Florian,

"pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de> writes:

> A good change (untested).
>
> It is not appropriate to write XXX: in comments on your first
> patch’s unit tests, as I understand the Wiktionary definition of XXX:
>
> 2. (computing) Used as a placeholder in source code to mark that some work
> still has to be done.

That's close to the meaning I use it for: something inelegant or dirty,
that would better be rewritten if someone knows better.  In other words,
it's functional but not ideal/hacky.  To mark some work that would need
doing in the future, I'd use a TODO instead.

I'm not sure if that's the most correct definition, but that's at least
how I've always understood it to be used in the Guix code base, e.g. by
Ludovic.

> Could you add this German translation?

Done, thank you!

> Additionally, I surrounded the info command in @command{} markup in the
> last line of the English news, too.
>
>         (title
>          (en "@samp{guix refresh} can now target partial versions")
>          (de "@samp{guix refresh} kann jetzt unvollständige Versionen als Ziel
> nehmen"))
>         (body
>          (en "While it had been possible for some time to use the
> @option{--target-version} to update to a partially defined version, this can
> now be more conveniently expressed via the package version specification
> directly, by prefixing it with the tilde (@samp{~}) character:
>
> @example
> $ guix refresh bash=~5.2
> gnu/packages/bash.scm:150:15: bash would be upgraded from 5.1.16 to 5.2.37
> @end example
>
> For more information, see @command{info \"(guix) Invoking guix refresh\"}.")

It doesn't seem to be explained in the Texinfo manual, but @command is
really only supposed to be used with a single word/command, not a
command line.  For the later @samp should be used instead.  That's
explained in (info "(texinfo) @command").

In this case though, I meant it to be this way: I've recently discovered
that when visiting a Texinfo node in a manual in Emacs, you can copy the
reference to it with 'C-0 c', then paste it somewhere.  Emacs users can
then jump straight to it by evaluating it with C-x C-e (with the cursor
placed after the closing parens).  I recently found that trick, I think
it's neat!  I seem to recall that Gnus also had a means to linkify such
references directly in email.

Thanks for the review and translation, as well as to Ludovic's.

Pushed with commit 450a3615325.  Closing.
diff mbox series

Patch

diff --git a/etc/news.scm b/etc/news.scm
index c70234ece7b..31684e53019 100644
--- a/etc/news.scm
+++ b/etc/news.scm
@@ -38,6 +38,22 @@ 
 (channel-news
  (version 0)
 
+ (entry (commit "XXX")
+        (title
+         (en "@samp{guix refresh} can now target partial versions"))
+        (body
+         (en "While it had been possible for some time to use the
+@option{--target-version} to update to a partially defined version, this can
+now be more conveniently expressed via the package version specification
+directly, by prefixing it with the tilde (@samp{~}) character:
+
+@example
+$ guix refresh bash=~5.2
+gnu/packages/bash.scm:150:15: bash would be upgraded from 5.1.16 to 5.2.37
+@end example
+
+For more information, see (info \"(guix) Invoking guix refresh\").")))
+
  (entry (commit "6e8ffdf3c5afac265e540027c2332573b25461ae")
         (title
          (en "Linux-libre 6.13 removed from Guix")