PR#42: fix identation and simplify some code blocks - fedora-docs/system-administrators-guide

fedora-docs / system-administrators-guide

#42 fix identation and simplify some code blocks

Merged 4 years ago by pbokoc. Opened 4 years ago by jibecfed.

fedora-docs/ jibecfed/system-administrators-guide masterWarn into master

fix identation and simplify some code blocks

Jibec • 4 years ago

d0478d0

modules/system-administrators-guide/pages/RPM.adoc

file modified

+16 -11

		`@@ -348,12 +348,12 @@`
		`Although there are many [application]RPM repositories on the Internet, for security and compatibility reasons, you should consider installing only official Fedora-provided RPM packages. The following is a list of sources for [application]RPM packages:`

		`* indexterm:[{MAJOROS} installation media,installable packages]`
		`- indexterm:[packages,{MAJOROS} installation media]`
		`- Official {MAJOROS} installation media.`
		`+ indexterm:[packages,{MAJOROS} installation media]`
		`+ Official {MAJOROS} installation media.`

		`* indexterm:[initial RPM repositories,installable packages]`
		`- indexterm:[packages,initial RPM repositories]`
		`- Official [application]RPM repositories provided with the [application]DNF package manager. See xref:package-management/DNF.adoc#ch-DNF[DNF] for details on how to use the official {MAJOROS} package repositories.`
		`+ indexterm:[packages,initial RPM repositories]`
		`+ Official [application]RPM repositories provided with the [application]DNF package manager. See xref:package-management/DNF.adoc#ch-DNF[DNF] for details on how to use the official {MAJOROS} package repositories.`

		`* Unofficial, third-party repositories not affiliated with {OSORG} also provide RPM packages.`

		`@@ -413,44 +413,49 @@`
		`[application]RPM is a useful tool for both managing your system and diagnosing and fixing problems. See the following examples for an overview of some of the most-used options.`

		* To verify your entire system and see what files are missing, issue the following command as `root`:
		`- indexterm:[RPM,finding deleted files with]indexterm:[packages,finding deleted files from]`
		`+ indexterm:[RPM,finding deleted files with]indexterm:[packages,finding deleted files from]`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -Va#`
		`----`
		`-`
		`+ +`
		`If some files are missing or appear corrupted, consider reinstalling relevant packages.`

		`* To determine which package owns a file, enter:`
		`- indexterm:[RPM,determining file ownership with]indexterm:[packages,determining file ownership with]`
		`+ indexterm:[RPM,determining file ownership with]indexterm:[packages,determining file ownership with]`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -qf _file_pass:attributes[{blank}]#`
		`----`

		* To verify the package that owns a particular file, enter as `root`:
		`-`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -Vf _file_pass:attributes[{blank}]#`
		`----`

		`* To locate documentation files that are a part of a package to which a file belongs, enter:`
		`- indexterm:[RPM,documentation with]indexterm:[packages,locating documentation for]indexterm:[documentation,finding installed]`
		`+ indexterm:[RPM,documentation with]indexterm:[packages,locating documentation for]indexterm:[documentation,finding installed]`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -qdf _file_pass:attributes[{blank}]#`
		`----`

		`* To find information about a (non-installed) package file, use the following command:`
		`- indexterm:[RPM,querying uninstalled packages]indexterm:[packages,querying uninstalled]`
		`+ indexterm:[RPM,querying uninstalled packages]indexterm:[packages,querying uninstalled]`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -qip _package.rpm_pass:attributes[{blank}]#`
		`----`

		`* To list files contained in a package, use:`
		`- indexterm:[RPM,querying for file list]indexterm:[packages,obtaining list of files]`
		`+ indexterm:[RPM,querying for file list]indexterm:[packages,obtaining list of files]`
		`+ +`
		`[subs="quotes, macros"]`
		`----`
		`[command]#rpm -qlp _package.rpm_pass:attributes[{blank}]#`

modules/system-administrators-guide/pages/infrastructure-services/TigerVNC.adoc

file modified

+29 -29

		`@@ -37,7 +37,7 @@`

		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}dnf install tigervnc-server`
		`+ # dnf install tigervnc-server`
		`----`

		`[[s3-configuring-vnc-server]]`
		`@@ -50,17 +50,17 @@`
		`[subs="macros, attributes"]`
		`----`

		- ~]#{nbsp}pass:quotes[`cp /lib/systemd/system/vncserver@.service /etc/systemd/system/vncserver@.service`]
		`+ # cp /lib/systemd/system/vncserver@.service /etc/systemd/system/vncserver@.service`

		`----`
		`+`
		There is no need to include the display number in the file name because `systemd` automatically creates the appropriately named instance in memory on demand, replacing `'%i'` in the service file by the display number. For a single user it is not necessary to rename the file. For multiple users, a uniquely named service file for each user is required, for example, by adding the user name to the file name in some way. See xref:TigerVNC.adoc#configuring-vncserver-2users[Configuring VNC Server for Two Users] for details.

		. Edit `/etc/systemd/system/vncserver@.service`,
		`- replacing _USER_ with the actual user name.`
		`- Leave the remaining lines of the file unmodified.`
		- The [option]`-geometry` argument specifies the size of the VNC desktop to
		- be created; by default, it is set to `1024x768`.
		`+ replacing _USER_ with the actual user name.`
		`+ Leave the remaining lines of the file unmodified.`
		+ The [option]`-geometry` argument specifies the size of the VNC desktop to
		+ be created; by default, it is set to `1024x768`.
		`+`
		`[subs="quotes, macros"]`
		`----`
		`@@ -77,7 +77,7 @@`
		`[subs="macros, attributes"]`
		`----`

		- ~]#{nbsp}pass:quotes[`systemctl daemon-reload`]
		+ # pass:quotes[`systemctl daemon-reload`]

		`----`

		`@@ -87,8 +87,8 @@`
		`[subs="macros, attributes"]`
		`----`

		`- ~]#{nbsp}su - pass:quotes[_USER_]`
		- ~]${nbsp}pass:quotes[`vncpasswd`]
		`+ # su - pass:quotes[_USER_]`
		+ $ pass:quotes[`vncpasswd`]
		`Password:`
		`Verify:`

		`@@ -119,12 +119,12 @@`
		`[subs="macros, attributes"]`
		`----`

		`- ~]${nbsp}su - USER_1`
		- ~]${nbsp}pass:quotes[`vncpasswd`]
		`+ $ su - USER_1`
		`+ $ vncpasswd`
		`Password:`
		`Verify:`
		`- ~]${nbsp}su - USER_2`
		- ~]${nbsp}pass:quotes[`vncpasswd`]
		`+ $ su - USER_2`
		`+ $ vncpasswd`
		`Password:`
		`Verify:`

		`@@ -141,7 +141,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]#{nbsp}systemctl start vncserver@:display_number.service`
		`+ # systemctl start vncserver@:display_number.service`

		`----`

		`@@ -150,7 +150,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]#{nbsp}systemctl enable vncserver@:display_number.service`
		`+ # systemctl enable vncserver@:display_number.service`

		`----`

		`@@ -166,8 +166,8 @@`
		`[subs="attributes"]`
		`----`

		`- ~]#{nbsp}systemctl start vncserver-USER_1@:3.service`
		`- ~]#{nbsp}systemctl start vncserver-USER_2@:5.service`
		`+ # systemctl start vncserver-USER_1@:3.service`
		`+ # systemctl start vncserver-USER_2@:5.service`

		`----`

		`@@ -180,7 +180,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]#{nbsp}systemctl disable vncserver@:display_number.service`
		`+ # systemctl disable vncserver@:display_number.service`

		`----`

		`@@ -190,7 +190,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]#{nbsp}systemctl stop vncserver@:display_number.service`
		`+ # systemctl stop vncserver@:display_number.service`

		`----`

		`@@ -212,7 +212,7 @@`

		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}dnf install tigervnc`
		`+ # dnf install tigervnc`
		`----`

		`[[s6-connecting-vnc-viewer]]`
		`@@ -238,7 +238,7 @@`
		`[subs="quotes, macros, attributes"]`
		`----`

		`- [command]#~]${nbsp}vncviewer 192.168.0.4:3#`
		`+ [command]#$ vncviewer 192.168.0.4:3#`

		`----`

		`@@ -264,12 +264,12 @@`
		`[[proc-Enabling_VNC_Service_in_firewalld]]`
		`.Enabling VNC Service in firewalld`
		. Run the following command to see the information concerning `firewalld`
		`- settings:`
		`+ settings:`
		`+`
		`[subs="quotes, macros, attributes"]`
		`----`

		`- [command]#~]${nbsp}firewall-cmd --list-all#`
		`+ [command]#$ firewall-cmd --list-all#`

		`----`

		`@@ -277,7 +277,7 @@`
		`+`
		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}firewall-cmd --add-rich-rule='rule family="ipv4" source address="192.168.122.116" service name=vnc-server accept'`
		`+ # firewall-cmd --add-rich-rule='rule family="ipv4" source address="192.168.122.116" service name=vnc-server accept'`
		`success`
		`----`
		`+`
		`@@ -287,7 +287,7 @@`
		`+`
		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}firewall-cmd --list-all`
		`+ # firewall-cmd --list-all`
		`public (default, active)`
		`interfaces: bond0 bond0.192`
		`sources:`
		`@@ -308,7 +308,7 @@`
		`+`
		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}firewall-cmd --zone=public --add-port=5904/tcp`
		`+ # firewall-cmd --zone=public --add-port=5904/tcp`
		`success`
		`----`

		`@@ -316,7 +316,7 @@`
		`+`
		`[subs="attributes"]`
		`----`
		`- ~]#{nbsp}firewall-cmd --zone=public --list-ports`
		`+ # firewall-cmd --zone=public --list-ports`
		`5904/tcp`
		`----`

		`@@ -334,7 +334,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]${nbsp}vncviewer -via user@host:display_number`
		`+ $ vncviewer -via user@host:display_number`

		`----`

		`@@ -347,7 +347,7 @@`
		`[subs="attributes"]`
		`----`

		`- ~]${nbsp}vncviewer -via USER_2@192.168.2.101:3`
		`+ $ vncviewer -via USER_2@192.168.2.101:3`

		`----`

modules/system-administrators-guide/pages/monitoring-and-automation/Viewing_and_Managing_Log_Files.adoc

file modified

+5 -3

		`@@ -2073,9 +2073,11 @@`
		`[[s2-logfiles-adding]]`
		`=== Adding a Log File`

		`- To add a log file you want to view in the list, select menu:File[`
		- > `Open` >
		- ]. This will display the `Open Log` window where you can select the directory and file name of the log file you want to view. xref:Viewing_and_Managing_Log_Files.adoc#fig-redhat-logviewer-add[System Log - adding a log file] illustrates the Open Log window.
		+ To add a log file you want to view in the list, select menu:File[> `Open` >].
		+ This will display the `Open Log` window where you can select the directory and
		`+ file name of the log file you want to view.`
		`+ xref:Viewing_and_Managing_Log_Files.adoc#fig-redhat-logviewer-add[System Log - adding a log file]`
		`+ illustrates the Open Log window.`

		`[[fig-redhat-logviewer-add]]`
		`.System Log - adding a log file`

modules/system-administrators-guide/pages/servers/Configuring_NTP_Using_ntpd.adoc

file modified

+3 -3

		`@@ -29,9 +29,9 @@`

		`** Mobile Phone Systems`

		`- ** Low Frequency Radio Broadcasts`
		`- WWVB (Colorado, USA.), JJY-40 and JJY-60 (Japan), DCF77 (Germany), and MSF (United Kingdom)`
		`-`
		`+ ** Low Frequency Radio Broadcasts+`
		`+ WWVB (Colorado, USA.), JJY-40 and JJY-60 (Japan), DCF77 (Germany), and MSF (United Kingdom)`
		`+ +`
		`These signals can be received by dedicated devices and are usually connected by RS-232 to a system used as an organizational or site-wide time server.`

		`Stratum 1::: Computer with radio clock, GPS clock, or atomic clock attached`

jibecfed commented 4 years ago

in the internationalization system of our docs, the tool po4a we use to convert asciidoc files into pot displays three lines of warning for each missing indentation.

most of the time it is cosmetic issues in adoc (like here), but sometimes it's po4a bugs that I want to see
this PR has no impact on your rendering, it is fully cosmetic