[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#927679: marked as done (Please use docbook entities strictly for re-usable parts)

Your message dated Sun, 22 Dec 2024 22:58:52 +0100
with message-id <[🔎] 5C0DD854-74A6-4712-A333-384D1BEE58EF@mailbox.org>
and subject line Re: release-notes bug triage
has caused the Debian Bug report #927679,
regarding Please use docbook entities strictly for re-usable parts
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@bugs.debian.org
immediately.)


-- 
927679: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=927679
Debian Bug Tracking System
Contact owner@bugs.debian.org with problems
--- Begin Message --- 
Package: release-notes
Severity: wishlist
X-Debbugs-CC: debian-i18n@lists.debian.org

On Sb, 20 apr 19, 21:11:09, Justin B Rye wrote:
> Andrei POPESCU wrote:
> >> +      disable it before the upgrade, to ensure login sessions work on
> >> +      &releasename;. (A possible route to re-enabling it is outlined on the
> > 
> > Any particular reason for using "&releasename;" instead of "buster"?
> > 
> > At least for me it's easier to read (and understand) the source text 
> > without so much markup.
> 
> I'll just have been copying the prevailing markup features from
> neighbouring sections..
> 
> Personally I would be happy to see &releasename; etc. eliminated in
> any section that won't be kept for the buster->bullseye edition (and
> the places that don't change should rarely mention releasenames).
> It's not quite as bad as &debian;, which almost never makes sense,
> since anybody recycling this document for (e.g.) Devuan would need to
> change almost everything else, too.

It appears to be best practice in programming to use variables just 
about everywhere.

In my opinion the same does not necessarily apply here because:

1. This is documentation

2. The source code itself is read by many, potentially non-programmers 
(i.e. translators).

Turning this into a wishlist bug against the Release Notes, hopefully to 
be considered for bullseye.
 
Kind regards,
Andrei
-- 
http://wiki.debian.org/FAQsFromDebianUser

Attachment: signature.asc
Description: PGP signature


--- End Message ---
--- Begin Message --- 
Hi,

Am 22. Dezember 2024 21:20:56 MEZ schrieb Paul Gevers <elbrus@debian.org>:
>On 22-12-2024 19:08, Richard Lewis wrote:
>> https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=927679
>> - is about docbook syntax. release-notes now use markdown. close?
>
>Absolutely. Except if the markdown setup also has something like "entities".

The "entities" are now called substitutions, like |RELEASENAME|.
See <https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html> 
In the release-notes they are defined in the conf.py file.

Back to the point of the bug:
I have fixed that during docbook->reST migration.
Substutions are used for content, which is likely be re-used in future
releases, otherwise not.

So I'm closing this bug.


Holger

-- 
Sent from /e/ OS on Fairphone3

--- End Message ---
Reply to: