#1277 Freshen Per-Product_Configuration document, syntactically/technically
Merged by tibbs. Opened by ferdnyc.
ferdnyc/packaging-committee per-product-update  into  master

Download 1277.patch

It's highly questionable how relevant or useful the information in this particular doc really is anymore (I know none of my Fedora installs have any value for VARIANT_ID in their /etc/os-release file)... but since it's currently part of the packaging guidelines, refresh the "Per-Product Configuration" document (with no substantive alterations to content) with:

  • A real title for the page (previously loaded as "Untitled")
  • Semantic newlines throughout
  • Enable syntax highlighting in specfile code blocks
  • backslash-continue & wrap very long specfile lines
  • Add inline code-literal fencing around body text
    uses of filesystem paths and filenames,
    specfile directives, etc.
  • Attach code snippets to bulleted list items as child
    blocks, where appropriate

I appreciate this though I wish that at least the semantic breaks were done as a separate commit from everything else, since we do have to review to make sure that there are no functional changes to the document.

However, it can't be merged as is, though I haven't looked at where the conflicts are. Any chance you could rebase?

However, it can't be merged as is, though I haven't looked at where the conflicts are. Any chance you could rebase?

Sure, and I'll break out the wrapping change while I'm at it; it's not that much work to split it out, and if I'm right about what's causing the conflict I'll probably have to re-apply the changes anyway.

(I think I got caught unawares (AGAIN) by Pagure's "Edit in your fork" semantics, where if you use it in a repo you've already forked, when it switches from upstream -> fork you end up editing the out-of-date file revision from whenever you last updated the fork, instead of the current revision you were just viewing in the upstream repo.)

...I should probably report that as a bug.

(Edit: Ayup:)

$ git log
commit 989b871 (HEAD -> per-product-update, origin/per-product-update)
Author: Frank Dana (FeRD) <ferdnyc@gmail.com>
Date:   2023-05-04 17:19:19 +0000
    Update guidelines/modules/ROOT/pages/Per-Product_Configuration.adoc
    - Give the page a real title (previously loaded as "Untitled")
    - Semantic newlines throughout
    - Enable syntax highlighting in specfile code blocks
    - backslash-continue & wrap very long specfile lines
    - Add inline code-literal fencing around body text
      uses of filesystem paths and filenames,
      specfile directives, etc.
commit 0d72dd5 (origin/master, origin/HEAD, tag-spec-source)
Author: Frank Dana (FeRD) <ferdnyc@gmail.com>
Date:   2022-04-11 07:10:00 +0000
    Tag specfile example source
    Enable syntax-highlighting of .spec file snippets by
    tagging them as source code in the 'rpm-spec' language.

rebased onto 80dc0e873c1732404e3df3bac96564bce4dac1b6

@tibbs

Should be all set, and the semantic-newlines changes are now (mostly) confined to the first commit.

(Although I think I did make some tweaks to the wrapping in the second commit, while I was adding inline markup. Edit: Nope! I was good, for once. Mark the day.)

Hmm. Turns out, when chopping large single-line paragraphs down to semantically-separated phrases, diffs are pretty ugly even if there aren't any other changes.

(I think I got caught unawares (AGAIN) by Pagure's "Edit in your fork" semantics, where if you use it in a repo you've already forked, when it switches from upstream -> fork you end up editing the out-of-date file revision from whenever you last updated the fork, instead of the current revision you were just viewing in the upstream repo.)

...I should probably report that as a bug.

@abitrolly beat me to it. :thumbsup:

@tibbs (Or anyone): As requested, I broke the semantic-newlines change out into a separate commit on this one. Anything further I need to do here?

rebased onto 1d19afc2a790c21e62d37abe1cbdc15c34c9489b

Pull-Request has been merged by tibbs

This is just formatting cleanup and I see no reason not to just merge it. I'm glad someone is trying to make the formatting better as I'm certainly no expert in asciidoc and have so little time these days.

Metadata