From d521d9a53516ed1cef9afdbd8859d54a73e4cfea Mon Sep 17 00:00:00 2001
From: Otto Liljalaakso <otto.liljalaakso@iki.fi>
Date: Jan 12 2024 11:29:43 +0000
Subject: Limit shell snippet line length in Package Maintenance Guide


For some shell snippets, the Package Maintenance Guide page used
a style where comment about certain command was written in the same
line after the command. Initially, this worked well when the commands
were short, but since then some quite long commands have been added,
leading to very long lines. Improve readability by swithing to
style where comments are on separate lines just before commands.

---

diff --git a/modules/ROOT/pages/Package_Maintenance_Guide.adoc b/modules/ROOT/pages/Package_Maintenance_Guide.adoc
index 3347e41..2a3d9a2 100644
--- a/modules/ROOT/pages/Package_Maintenance_Guide.adoc
+++ b/modules/ROOT/pages/Package_Maintenance_Guide.adoc
@@ -290,9 +290,11 @@ fedpkg clone foo
 cd foo
 fedpkg sources
 fedpkg new-sources foo-0.0.2.tar.bz2
-gedit foo.spec       # change the required things in the specfile.
-                     # rpmdev-bumpspec is useful for simple version updates
-fedpkg mockbuild     # check that the changes you made are correct
+# Change the required things in the specfile.
+# 'rpmdev-bumpspec' is useful for simple version updates.
+gedit foo.spec
+# Check that the changes you made are correct.
+fedpkg mockbuild
 fedpkg diff
 fedpkg lint
 fedpkg commit -p -c  # commit and push in one go
@@ -399,9 +401,9 @@ and dealing with them as a set.
 git config --global merge.tool meld
 fedpkg switch-branch f{{FedoraVersionNumber}}
 git merge rawhide
-# Conflicts occurred
-git mergetool            # Opens up a meld showing a three way diff of 
-                         # the merge, working tree, and the last commit
+# Conflicts occurred.
+# Open a meld showing a three way diff of the merge, working tree, and the last commit.
+git mergetool
 # Resolved all the conflicts in the GUI
 git add CONFLICTEDFILES
 git commit
@@ -443,17 +445,22 @@ typical `fedpkg` session might look like this:
 ....
 fedpkg clone --anonymous forks/my-username/rpms/somepackage
 cd somepackage
-gedit somepackage.spec    # change the required things in the specfile.
-                          # rpmdev-bumpspec is useful for simple version updates
-spectool -g somepackage.spec # download the referenced sources to local machine
-fedpkg mockbuild          # check that the changes you made are correct
-fedpkg new-sources --offline somepackage-0.0.2.tar.gz # update sources file and .gitignore if sources have changed
-                                                      # the --offline flag skips upload to the lookaside cache
-                                                      # that is left for the maintainer to do after the pull request has been merged
-                                                      # multiple source files can be specified as required
+# change the required things in the specfile.
+# 'rpmdev-bumpspec' is useful for simple version updates.
+gedit somepackage.spec
+# download the referenced sources to local machine
+spectool -g somepackage.spec
+# check that the changes you made are correct
+fedpkg mockbuild
+# Update sources file and .gitignore if sources have changed.
+# The --offline flag skips upload to the lookaside cache.
+# That is left for the maintainer to do after the pull request has been merged.
+# Multiple source files can be specified as required.
+fedpkg new-sources --offline somepackage-0.0.2.tar.gz
 fedpkg diff
 fedpkg lint
-git checkout -b my-branch # create a branch to use in the pull request
+# create a branch to use in the pull request
+git checkout -b my-branch
 git status
 git add .
 git commit