From 2d1c944ba01711d31979d9324d8bd431ef8597fc Mon Sep 17 00:00:00 2001 From: Didik Supriadi Date: May 11 2020 15:38:34 +0000 Subject: [PATCH 1/3] Fix internal xrefs --- diff --git a/modules/install-guide/pages/advanced/Boot_Options.adoc b/modules/install-guide/pages/advanced/Boot_Options.adoc index 33e2d41..7e0c5a2 100644 --- a/modules/install-guide/pages/advanced/Boot_Options.adoc +++ b/modules/install-guide/pages/advanced/Boot_Options.adoc @@ -80,7 +80,7 @@ Disk device names may be specified using the following formats: + Non-alphanumeric characters must be represented as `\xpass:attributes[{blank}]_NN_pass:attributes[{blank}]`, where _NN_ is the hexadecimal representation of the character. For example, `\x20` is a white space (""). -[option]#inst.stage2=#:: Specifies the location of the installation program runtime image to be loaded. The syntax is the same as in xref:Boot_Options.adoc#tabl-boot-options-sources[Installation Sources]. This option expects a path to a directory containing a valid `.treeinfo` file; the location of the runtime image will be read from this file if found. If a `.treeinfo` file is not available, [application]*Anaconda* will try to load the image from `LiveOS/squashfs.img`. +[option]#inst.stage2=#:: Specifies the location of the installation program runtime image to be loaded. The syntax is the same as in xref:tabl-boot-options-sources[Installation Sources]. This option expects a path to a directory containing a valid `.treeinfo` file; the location of the runtime image will be read from this file if found. If a `.treeinfo` file is not available, [application]*Anaconda* will try to load the image from `LiveOS/squashfs.img`. + [NOTE] ==== @@ -91,7 +91,7 @@ By default, this boot option is used on the installation media and set to a spec [option]#inst.stage2.all=#:: With this boot option, the stage 2 image will be fetched from HTTP, HTTPS and FTP locations which are specified using the [option]#inst.stage2=# option sequentially in the order they are specified, until the image is successfully fetched. All other locations will be ignored. -[option]#inst.dd=#:: If you need to perform a driver update during the installation, use the [option]#inst.dd=# option. It can be used multiple times. The location of a driver RPM package can be specified using any of the formats described in xref:Boot_Options.adoc#tabl-boot-options-sources[Installation Sources]. With the exception of the [option]#inst.dd=cdrom# option, the device name must always be specified. For example: +[option]#inst.dd=#:: If you need to perform a driver update during the installation, use the [option]#inst.dd=# option. It can be used multiple times. The location of a driver RPM package can be specified using any of the formats described in xref:tabl-boot-options-sources[Installation Sources]. With the exception of the [option]#inst.dd=cdrom# option, the device name must always be specified. For example: + [subs="quotes, macros"] ---- @@ -116,7 +116,7 @@ Using this option will leave the installation source configuration in an error s [[sect-boot-options-kickstart]] === Kickstart Boot Options -[option]#inst.ks=#:: Gives the location of a Kickstart file to be used to automate the installation. Locations can be specified using any of the formats valid for [option]#inst.repo=#. See xref:Boot_Options.adoc#tabl-boot-options-sources[Installation Sources] for valid formats. +[option]#inst.ks=#:: Gives the location of a Kickstart file to be used to automate the installation. Locations can be specified using any of the formats valid for [option]#inst.repo=#. See xref:tabl-boot-options-sources[Installation Sources] for valid formats. + If you only specify a device and not a path, the installation program will look for the Kickstart file in `/ks.cfg` on the specified device. If you use this option without specifying a device, the installation program will use the following: + @@ -186,7 +186,7 @@ If this option is not specified, [application]*Anaconda* will use `provider_fedo [option]#inst.keymap=#:: Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the [command]#keyboard# Kickstart command as described in xref:appendixes/Kickstart_Syntax_Reference.adoc#appe-kickstart-syntax-reference[Kickstart Syntax Reference]. -[option]#inst.text#:: Forces the installation program to run in text mode instead of graphical mode. The text user interface is limited, for example, it does not allow you to modify the partition layout or set up LVM. When installing a system on a machine with a limited graphical capabilities, it is recommended to use VNC as described in xref:Boot_Options.adoc#sect-boot-options-vnc[Enabling Remote Access Using VNC]. +[option]#inst.text#:: Forces the installation program to run in text mode instead of graphical mode. The text user interface is limited, for example, it does not allow you to modify the partition layout or set up LVM. When installing a system on a machine with a limited graphical capabilities, it is recommended to use VNC as described in xref:sect-boot-options-vnc[Enabling Remote Access Using VNC]. [option]#inst.cmdline#:: Forces the installation program to run in command line mode. This mode does not allow any interaction, all options must be specified in a Kickstart file or on the command line. @@ -398,7 +398,7 @@ Password: [[sect-boot-options-debug]] === Debugging and Troubleshooting -[option]#inst.updates=#:: Specifies the location of the `updates.img` file to be applied to the installation program runtime. The syntax is the same as in the [option]#inst.repo# option - see xref:Boot_Options.adoc#tabl-boot-options-sources[Installation Sources] for details. In all formats, if you do not specify a file name but only a directory, the installation program will look for a file named `updates.img`. +[option]#inst.updates=#:: Specifies the location of the `updates.img` file to be applied to the installation program runtime. The syntax is the same as in the [option]#inst.repo# option - see xref:tabl-boot-options-sources[Installation Sources] for details. In all formats, if you do not specify a file name but only a directory, the installation program will look for a file named `updates.img`. [option]#inst.loglevel=#:: Specifies the minimum level for messages to be logged on a terminal. This only concerns real-time logging in a terminal; log files will always contain messages of all levels. + diff --git a/modules/install-guide/pages/advanced/Upgrading_Your_Current_System.adoc b/modules/install-guide/pages/advanced/Upgrading_Your_Current_System.adoc index 5766c11..b4d4909 100644 --- a/modules/install-guide/pages/advanced/Upgrading_Your_Current_System.adoc +++ b/modules/install-guide/pages/advanced/Upgrading_Your_Current_System.adoc @@ -9,7 +9,7 @@ This chapter explains how to upgrade your existing {PRODUCT} installation to the Automatic upgrade using [application]*dnf system upgrade*:: The preferred way to upgrade your system is an automatic upgrade using the [application]*dnf system upgrade* utility. For information on performing an automatic upgrade, see link:++https://fedoraproject.org/wiki/DNF_system_upgrade++[Fedora Wiki DNF system upgrade]. -Manual Reinstallation:: You can upgrade to the latest version of Fedora manually instead of relying on [application]*dnf system upgrade*. This involves booting the installer as if you were performing a clean installation, letting it detect your existing Fedora system, and overwriting the root partition while preserving data on other partitions and volumes. The same process can also be used to reinstall the system, if you need to. For detailed information, see xref:Upgrading_Your_Current_System.adoc#sect-upgrading-fedora-manual-reinstall[Manual System Upgrade or Reinstallation]. +Manual Reinstallation:: You can upgrade to the latest version of Fedora manually instead of relying on [application]*dnf system upgrade*. This involves booting the installer as if you were performing a clean installation, letting it detect your existing Fedora system, and overwriting the root partition while preserving data on other partitions and volumes. The same process can also be used to reinstall the system, if you need to. For detailed information, see xref:sect-upgrading-fedora-manual-reinstall[Manual System Upgrade or Reinstallation]. [WARNING] ==== diff --git a/modules/install-guide/pages/advanced/VNC_Installations.adoc b/modules/install-guide/pages/advanced/VNC_Installations.adoc index fcb59d5..f314ebc 100644 --- a/modules/install-guide/pages/advanced/VNC_Installations.adoc +++ b/modules/install-guide/pages/advanced/VNC_Installations.adoc @@ -69,7 +69,7 @@ VNC Direct Mode is when the VNC viewer initiates a connection to the system bein [[proc-vnc-installations-direct-mode]] .Starting VNC in Direct Mode -. Open the VNC viewer (for example, [application]*TigerVNC*) on the workstation you will be using to connect to the system being installed. A window similar to xref:VNC_Installations.adoc#figu-vnc-installations-connection-details[TigerVNC Connection Details] will be displayed with an input field allowing you to specify an IP address. +. Open the VNC viewer (for example, [application]*TigerVNC*) on the workstation you will be using to connect to the system being installed. A window similar to xref:figu-vnc-installations-connection-details[TigerVNC Connection Details] will be displayed with an input field allowing you to specify an IP address. + [[figu-vnc-installations-connection-details]] .TigerVNC Connection Details @@ -171,6 +171,6 @@ When installing headless systems, the only choices are an automated Kickstart in . Set up a PXE server that will be used to start the installation. Information about installing and performing basic configurating of a PXE server can be found in xref:advanced/Network_based_Installations.adoc#chap-pxe-server-setup[Setting Up an Installation Server]. -. Configure the PXE server to use the boot options for a connect mode VNC installation. For information on these boot options, see xref:VNC_Installations.adoc#sect-vnc-installations-connect-mode[Installing in VNC Connect Mode]. +. Configure the PXE server to use the boot options for a connect mode VNC installation. For information on these boot options, see xref:sect-vnc-installations-connect-mode[Installing in VNC Connect Mode]. -. Follow the procedure for a VNC Installation using connect mode as described in the xref:VNC_Installations.adoc#proc-vnc-installations-connect-mode[Starting VNC in Connect Mode]. However, when directed to boot the system, boot it from the PXE server. +. Follow the procedure for a VNC Installation using connect mode as described in the xref:proc-vnc-installations-connect-mode[Starting VNC in Connect Mode]. However, when directed to boot the system, boot it from the PXE server. diff --git a/modules/install-guide/pages/appendixes/Disk_Partitions.adoc b/modules/install-guide/pages/appendixes/Disk_Partitions.adoc index 95ca591..4f45ea6 100644 --- a/modules/install-guide/pages/appendixes/Disk_Partitions.adoc +++ b/modules/install-guide/pages/appendixes/Disk_Partitions.adoc @@ -14,7 +14,7 @@ This appendix is not necessarily applicable to architectures other than AMD64 an This section discusses basic disk concepts, disk repartitioning strategies, the partition naming scheme used by Linux systems, and related topics. -If you are comfortable with disk partitions, you can skip ahead to xref:Disk_Partitions.adoc#sect-disk-partitions-making-room[Strategies for Disk Repartitioning] for more information on the process of freeing up disk space to prepare for a {PRODUCT} installation. +If you are comfortable with disk partitions, you can skip ahead to xref:sect-disk-partitions-making-room[Strategies for Disk Repartitioning] for more information on the process of freeing up disk space to prepare for a {PRODUCT} installation. [[sect-disk-partitions-basic-concepts]] == Hard Disk Basic Concepts @@ -23,7 +23,7 @@ Hard disks perform a very simple function - they store data and reliably retriev When discussing issues such as disk partitioning, it is important to have a understanding of the underlying hardware; however, since the theory is very complicated and expansive, only the basic concepts will be explained here. This appendix uses a set of simplified diagrams of a disk drive to help explain what is the process and theory behind partitions. -xref:Disk_Partitions.adoc#figu-partitions-unused-drive[An Unused Disk Drive], shows a brand-new, unused disk drive. +xref:figu-partitions-unused-drive[An Unused Disk Drive], shows a brand-new, unused disk drive. [[figu-partitions-unused-drive]] .An Unused Disk Drive @@ -40,13 +40,13 @@ To store data on a disk drive, it is necessary to _format_ the disk drive first. image::partitions/formatted-drive.png[Image of a formatted disk drive.] -As xref:Disk_Partitions.adoc#figu-partitions-formatted-drive[Disk Drive with a File System], implies, the order imposed by a file system involves some trade-offs: +As xref:figu-partitions-formatted-drive[Disk Drive with a File System], implies, the order imposed by a file system involves some trade-offs: * A small percentage of the driver's available space is used to store file system-related data and can be considered as overhead. * A file system splits the remaining space into small, consistently-sized segments. For Linux, these segments are known as _blocks_ footnote:[Blocks really *are* consistently sized, unlike our illustrations. Keep in mind, also, that an average disk drive contains thousands of blocks. The picture is simplified for the purposes of this discussion.]. -Note that there is no single, universal file system. As xref:Disk_Partitions.adoc#figu-partitions-different-file-system[Disk Drive with a Different File System], shows, a disk drive may have one of many different file systems written on it. Different file systems tend to be incompatible; that is, an operating system that supports one file system (or a handful of related file system types) may not support another. However, {PRODUCT} supports a wide variety of file systems (including many commonly used by other operating systems such as Microsoft Windows), making data interchange between different file systems easy. +Note that there is no single, universal file system. As xref:figu-partitions-different-file-system[Disk Drive with a Different File System], shows, a disk drive may have one of many different file systems written on it. Different file systems tend to be incompatible; that is, an operating system that supports one file system (or a handful of related file system types) may not support another. However, {PRODUCT} supports a wide variety of file systems (including many commonly used by other operating systems such as Microsoft Windows), making data interchange between different file systems easy. [[figu-partitions-different-file-system]] .Disk Drive with a Different File System @@ -60,7 +60,7 @@ Writing a file system to disk is only the first step. The goal of this process i image::partitions/used-formatted-drive.png[Image of a disk drive with data written to it.] -As xref:Disk_Partitions.adoc#figu-partitions-drive-with-data[Disk Drive with Data Written to It], shows, some of the previously-empty blocks are now holding data. However, by just looking at this picture, we cannot determine exactly how many files reside on this drive. There may only be one file or many, as all files use at least one block and some files use multiple blocks. Another important point to note is that the used blocks do not have to form a contiguous region; used and unused blocks may be interspersed. This is known as _fragmentation_. Fragmentation can play a part when attempting to resize an existing partition. +As xref:figu-partitions-drive-with-data[Disk Drive with Data Written to It], shows, some of the previously-empty blocks are now holding data. However, by just looking at this picture, we cannot determine exactly how many files reside on this drive. There may only be one file or many, as all files use at least one block and some files use multiple blocks. Another important point to note is that the used blocks do not have to form a contiguous region; used and unused blocks may be interspersed. This is known as _fragmentation_. Fragmentation can play a part when attempting to resize an existing partition. As with most computer-related technologies, disk drives changed over time after their introduction. In particular, they got bigger. Not larger in physical size, but bigger in their capacity to store information. And, this additional capacity drove a fundamental change in the way disk drives were used. @@ -77,7 +77,7 @@ There are several reasons for allocating disk space into separate disk partition * Ability to run multiple operating systems on one machine -There are currently two partitioning layout standards for physical hard disks: Master Boot Record (*MBR*) and GUID Partition Table (*GPT*). *MBR* is an older method of disk partitioning used with BIOS-based computers. *GPT* is a newer partitioning layout that is a part of the Unified Extensible Firmware Interface (*UEFI*). This section and xref:Disk_Partitions.adoc#sect-disk-partitions-extended[Partitions Within Partitions - An Overview of Extended Partitions] mainly describe the _Master Boot Record_ (*MBR*) disk partitioning scheme. For information about the _GUID Partition Table_ (*GPT*) partitioning layout, see xref:Disk_Partitions.adoc#sect-disk-partitioning-guid-partition-table[GUID Partition Table (GPT)]. +There are currently two partitioning layout standards for physical hard disks: Master Boot Record (*MBR*) and GUID Partition Table (*GPT*). *MBR* is an older method of disk partitioning used with BIOS-based computers. *GPT* is a newer partitioning layout that is a part of the Unified Extensible Firmware Interface (*UEFI*). This section and xref:sect-disk-partitions-extended[Partitions Within Partitions - An Overview of Extended Partitions] mainly describe the _Master Boot Record_ (*MBR*) disk partitioning scheme. For information about the _GUID Partition Table_ (*GPT*) partitioning layout, see xref:sect-disk-partitioning-guid-partition-table[GUID Partition Table (GPT)]. [NOTE] ==== @@ -91,7 +91,7 @@ While the diagrams in this chapter show the partition table as being separate fr image::partitions/unused-partitioned-drive.png[Image of an unused disk drive with a partition table.] -As xref:Disk_Partitions.adoc#figu-partitions-partition-table[Disk Drive with Partition Table] shows, the partition table is divided into four sections or four _primary_ partitions. A primary partition is a partition on a hard drive that can contain only one logical drive (or section). Each section can hold the information necessary to define a single partition, meaning that the partition table can define no more than four partitions. +As xref:figu-partitions-partition-table[Disk Drive with Partition Table] shows, the partition table is divided into four sections or four _primary_ partitions. A primary partition is a partition on a hard drive that can contain only one logical drive (or section). Each section can hold the information necessary to define a single partition, meaning that the partition table can define no more than four partitions. Each partition table entry contains several important characteristics of the partition: @@ -105,7 +105,7 @@ The starting and ending points define the partition's size and location on the d The type is a number that identifies the partition's anticipated usage. Some operating systems use the partition type to denote a specific file system type, to flag the partition as being associated with a particular operating system, to indicate that the partition contains a bootable operating system, or some combination of the three. -See xref:Disk_Partitions.adoc#figu-partitions-single-part[Disk Drive With Single Partition] for an example of a disk drive with single partition. +See xref:figu-partitions-single-part[Disk Drive With Single Partition] for an example of a disk drive with single partition. [[figu-partitions-single-part]] .Disk Drive With Single Partition @@ -147,7 +147,7 @@ The single partition in this example is labeled as `DOS`. This label shows the * In case four partitions are insufficient for your needs, you can use _extended partitions_ to create up additional partitions. You do this by setting the type of a partition to "Extended". -An extended partition is like a disk drive in its own right - it has its own partition table which points to one or more partitions (now called _logical partitions_, as opposed to the four _primary partitions_) contained entirely within the extended partition itself. xref:Disk_Partitions.adoc#figu-partitions-extended[Disk Drive With Extended Partition], shows a disk drive with one primary partition and one extended partition containing two logical partitions (along with some unpartitioned free space). +An extended partition is like a disk drive in its own right - it has its own partition table which points to one or more partitions (now called _logical partitions_, as opposed to the four _primary partitions_) contained entirely within the extended partition itself. xref:figu-partitions-extended[Disk Drive With Extended Partition], shows a disk drive with one primary partition and one extended partition containing two logical partitions (along with some unpartitioned free space). [[figu-partitions-extended]] .Disk Drive With Extended Partition @@ -203,7 +203,7 @@ Keep in mind that the following illustrations are simplified in the interest of [[sect-disk-partitions-using-free-space]] === Using Unpartitioned Free Space -In this situation, the partitions already defined do not span the entire hard disk, leaving unallocated space that is not part of any defined partition. xref:Disk_Partitions.adoc#figu-partitions-unused-space[Disk Drive with Unpartitioned Free Space], shows what this might look like. +In this situation, the partitions already defined do not span the entire hard disk, leaving unallocated space that is not part of any defined partition. xref:figu-partitions-unused-space[Disk Drive with Unpartitioned Free Space], shows what this might look like. [[figu-partitions-unused-space]] .Disk Drive with Unpartitioned Free Space @@ -214,12 +214,12 @@ In the above example, `1` represents an undefined partition with unallocated spa An unused hard disk also falls into this category. The only difference is that *all* the space is not part of any defined partition. -In any case, you can create the necessary partitions from the unused space. Unfortunately, this scenario, although very simple, is not very likely (unless you have just purchased a new disk just for {PRODUCT}). Most pre-installed operating systems are configured to take up all available space on a disk drive (see xref:Disk_Partitions.adoc#sect-disk-partitions-active-partition[Using Free Space from an Active Partition]). +In any case, you can create the necessary partitions from the unused space. Unfortunately, this scenario, although very simple, is not very likely (unless you have just purchased a new disk just for {PRODUCT}). Most pre-installed operating systems are configured to take up all available space on a disk drive (see xref:sect-disk-partitions-active-partition[Using Free Space from an Active Partition]). [[sect-disk-partitions-unused-partition]] === Using Space from an Unused Partition -In this case, maybe you have one or more partitions that you do not use any longer. xref:Disk_Partitions.adoc#figu-partitions-unused-partition[Disk Drive with an Unused Partition], illustrates such a situation. +In this case, maybe you have one or more partitions that you do not use any longer. xref:figu-partitions-unused-partition[Disk Drive with an Unused Partition], illustrates such a situation. [[figu-partitions-unused-partition]] .Disk Drive with an Unused Partition @@ -246,7 +246,7 @@ If an operating system was installed on that partition, it must be reinstalled i ==== + -After creating a smaller partition for your existing operating system, you can reinstall software, restore your data, and start the installation. xref:Disk_Partitions.adoc#figu-partitions-destructive-repartitioning[Disk Drive Being Destructively Repartitioned] shows this being done. +After creating a smaller partition for your existing operating system, you can reinstall software, restore your data, and start the installation. xref:figu-partitions-destructive-repartitioning[Disk Drive Being Destructively Repartitioned] shows this being done. + [[figu-partitions-destructive-repartitioning]] .Disk Drive Being Destructively Repartitioned @@ -291,7 +291,7 @@ This step is crucial. Without it, the location of the data could prevent the par [[sect-disk-partitions-resize-existing]] ==== Resize the Existing Partition -xref:Disk_Partitions.adoc#figu-partitions-resize-existing[Disk Drive with Partition Resized] shows the actual resizing process. While the actual result of the resizing operation varies depending on the software used, in most cases the newly freed space is used to create an unformatted partition of the same type as the original partition. +xref:figu-partitions-resize-existing[Disk Drive with Partition Resized] shows the actual resizing process. While the actual result of the resizing operation varies depending on the software used, in most cases the newly freed space is used to create an unformatted partition of the same type as the original partition. [[figu-partitions-resize-existing]] .Disk Drive with Partition Resized @@ -305,7 +305,7 @@ It is important to understand what the resizing software you use does with the n [[sect-disk-partitions-create-new]] ==== Create new partition(s) -As the previous step implied, it may or may not be necessary to create new partitions. However, unless your resizing software is Linux-aware, it is likely that you must delete the partition that was created during the resizing process. xref:Disk_Partitions.adoc#figu-partitions-final-configuration[Disk Drive with Final Partition Configuration], shows this being done. +As the previous step implied, it may or may not be necessary to create new partitions. However, unless your resizing software is Linux-aware, it is likely that you must delete the partition that was created during the resizing process. xref:figu-partitions-final-configuration[Disk Drive with Final Partition Configuration], shows this being done. [[figu-partitions-final-configuration]] .Disk Drive with Final Partition Configuration diff --git a/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc b/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc index 0643e4b..6cf39ad 100644 --- a/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc +++ b/modules/install-guide/pages/appendixes/Kickstart_Syntax_Reference.adoc @@ -432,7 +432,7 @@ Create a Btrfs volume or subvolume. For a volume, the syntax is: ---- -One or more partitions can be specified in _partitions_. When specifying more than one partitions, the entries must be separated by a single space. See xref:Kickstart_Syntax_Reference.adoc#exam-kickstart-create-btrfs[Creating Btrfs Volumes and Subvolumes] for a demonstration. +One or more partitions can be specified in _partitions_. When specifying more than one partitions, the entries must be separated by a single space. See xref:exam-kickstart-create-btrfs[Creating Btrfs Volumes and Subvolumes] for a demonstration. For a subvolume, the syntax is: @@ -492,7 +492,7 @@ If the [command]#clearpart# command is used, then the [command]#part --onpart# c ==== -For a detailed example of partitioning including the [command]#clearpart# command, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. +For a detailed example of partitioning including the [command]#clearpart# command, see xref:sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. [option]#--all#:: Erases all partitions from the system. + @@ -647,7 +647,7 @@ To include a multipath device that uses LVM: [[sect-kickstart-commands-iscsi]] === iscsi (optional) - Configure iSCSI Devices -Specifies additional iSCSI storage to be attached during installation. If you use the [command]#iscsi# command, you must also assign a name to the iSCSI node, using the [command]#iscsiname# command (see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-iscsiname[iscsiname (optional) - Assign Name to iSCSI Device]. The [command]#iscsiname# command must appear before the [command]#iscsi# command in the Kickstart file. +Specifies additional iSCSI storage to be attached during installation. If you use the [command]#iscsi# command, you must also assign a name to the iSCSI node, using the [command]#iscsiname# command (see xref:sect-kickstart-commands-iscsiname[iscsiname (optional) - Assign Name to iSCSI Device]. The [command]#iscsiname# command must appear before the [command]#iscsi# command in the Kickstart file. You should configure iSCSI storage in the system BIOS or firmware (iBFT for Intel systems) rather than use the [command]#iscsi# command if possible. If you do so, [application]*Anaconda* automatically detects and uses disks configured in BIOS or firmware and no special configuration is necessary in the Kickstart file. @@ -677,7 +677,7 @@ If you must use the [command]#iscsi# command, make sure that networking is activ [[sect-kickstart-commands-iscsiname]] === iscsiname (optional) - Assign Name to iSCSI Device -Assigns a name to an iSCSI node specified by the [command]#iscsi# command (xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-iscsi[iscsi (optional) - Configure iSCSI Devices]). This command is mandatory if you use the [command]#iscsi# command, and it must be specified *before* you use [command]#iscsi#. +Assigns a name to an iSCSI node specified by the [command]#iscsi# command (xref:sect-kickstart-commands-iscsi[iscsi (optional) - Configure iSCSI Devices]). This command is mandatory if you use the [command]#iscsi# command, and it must be specified *before* you use [command]#iscsi#. [subs="quotes, macros"] ---- @@ -703,7 +703,7 @@ This limitation only applies to newly created logical volume and volume group na ==== -For a detailed example of [command]#logvol# in action, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. +For a detailed example of [command]#logvol# in action, see xref:sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. _mntpoint_:: Replace with the volume's mount point. This name can take the following forms: + @@ -823,7 +823,7 @@ Only one of [option]#--pbkdf-time=# or [option]#--pbkdf-iterations=# can be spec + Only one of [option]#--pbkdf-time=# or [option]#--pbkdf-iterations=# can be specified at the same time. -Create one or more partitions first using xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-part[part (required) - Create Physical Partition], create the logical volume group (xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-volgroup[volgroup (optional) - Create LVM Volume Group]), and then create logical volumes. For example: +Create one or more partitions first using xref:sect-kickstart-commands-part[part (required) - Create Physical Partition], create the logical volume group (xref:sect-kickstart-commands-volgroup[volgroup (optional) - Create LVM Volume Group]), and then create logical volumes. For example: [subs="quotes, macros"] ---- @@ -839,7 +839,7 @@ Create one or more partitions first using xref:Kickstart_Syntax_Reference.adoc#s Creates a partition on the system. -For a detailed example of [command]#part# in action, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. +For a detailed example of [command]#part# in action, see xref:sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. [subs="quotes, macros"] ---- @@ -890,11 +890,11 @@ For the swap sizes assigned by these commands, see the section describing swap i + `raid._id_pass:attributes[{blank}]`::: The partition is used for software RAID (see [command]#raid#). + -`pv._id_pass:attributes[{blank}]`::: The partition is used for LVM (see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-part[part (required) - Create Physical Partition]). +`pv._id_pass:attributes[{blank}]`::: The partition is used for LVM (see xref:sect-kickstart-commands-part[part (required) - Create Physical Partition]). + -`biosboot`::: The partition will be used for a BIOS Boot partition. A 1 MB BIOS boot partition is necessary on BIOS-based systems using a _GUID Partition Table_ (GPT); the boot loader will be installed into it. It is not necessary on UEFI systems. Also see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-part[part (required) - Create Physical Partition]. +`biosboot`::: The partition will be used for a BIOS Boot partition. A 1 MB BIOS boot partition is necessary on BIOS-based systems using a _GUID Partition Table_ (GPT); the boot loader will be installed into it. It is not necessary on UEFI systems. Also see xref:sect-kickstart-commands-part[part (required) - Create Physical Partition]. + -`/boot/efi`::: An EFI System Partition. An EFI partition at least 50 MB in size is necessary on UEFI-based systems; the recommended size is 200 MB. It is not necessary on BIOS systems. Also see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-part[part (required) - Create Physical Partition]. +`/boot/efi`::: An EFI System Partition. An EFI partition at least 50 MB in size is necessary on UEFI-based systems; the recommended size is 200 MB. It is not necessary on BIOS systems. Also see xref:sect-kickstart-commands-part[part (required) - Create Physical Partition]. [option]#--size=#:: The minimum partition size in megabytes. Specify an integer value here such as `500` (do not include the unit). + @@ -1032,7 +1032,7 @@ raid mntpoint --level=level --device=mddevice partitions* ---- -For a detailed example of [command]#raid# in action, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. +For a detailed example of [command]#raid# in action, see xref:sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. _mntpoint_:: Location where the RAID file system is mounted. If it is `/`, the RAID level must be 1 unless a boot partition (`/boot`) is present. If a boot partition is present, the `/boot` partition must be level 1 and the root (`/`) partition can be any of the available types. The _partitions*_ (which denotes that multiple partitions can be listed) lists the RAID identifiers to add to the RAID array. @@ -1150,7 +1150,7 @@ This limitation only applies to newly created logical volume and volume group na ==== -For a detailed partitioning example including [command]#volgroup#, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. +For a detailed partitioning example including [command]#volgroup#, see xref:sect-kickstart-example-advanced-partitioning[Advanced Partitioning Example]. [option]#--noformat#:: Use an existing volume group and do not format it. @@ -1162,7 +1162,7 @@ For a detailed partitioning example including [command]#volgroup#, see xref:Kick [option]#--reserved-percent=#:: Specify a percentage of total volume group space to leave unused. Applicable only to newly created volume groups. -Create one or more partitions first using xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-part[part (required) - Create Physical Partition], create the logical volume group (xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-volgroup[volgroup (optional) - Create LVM Volume Group]), and then create logical volumes. For example: +Create one or more partitions first using xref:sect-kickstart-commands-part[part (required) - Create Physical Partition], create the logical volume group (xref:sect-kickstart-commands-volgroup[volgroup (optional) - Create LVM Volume Group]), and then create logical volumes. For example: [subs="quotes, macros"] ---- @@ -1639,7 +1639,7 @@ The `libpwquality` library is used to check minimum password requirements (lengt [IMPORTANT] ==== -This command must be used inside the [command]#%anaconda# section. See xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-anaconda[%anaconda (optional) - Additional Anaconda Configuration] for details. +This command must be used inside the [command]#%anaconda# section. See xref:sect-kickstart-commands-anaconda[%anaconda (optional) - Additional Anaconda Configuration] for details. ==== @@ -1736,7 +1736,7 @@ Sets the state of SELinux on the installed system. The default policy is `enforc [[sect-kickstart-commands-sshkey]] === sshkey (optional) - Add an Authorized SSH Key -Use this command to add a specified `SSH` key to an user's `authorized_keys` file. The specified user must either be `root`, or it must be created in the Kickstart file - either automatically by an installed package, or using xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-user[user (optional) - Create User Account]. +Use this command to add a specified `SSH` key to an user's `authorized_keys` file. The specified user must either be `root`, or it must be created in the Kickstart file - either automatically by an installed package, or using xref:sect-kickstart-commands-user[user (optional) - Create User Account]. ---- sshkey --username=user "ssh_key" @@ -1760,7 +1760,7 @@ Creates a new user on the system. [option]#--gecos=#:: Provides the GECOS information for the user. This is a string of various system-specific fields separated by a comma. It is frequently used to specify the user's full name, office number, etc. See the `passwd(5)` man page for more details. -[option]#--groups=#:: In addition to the default group, a comma separated list of group names the user should belong to. The groups must exist before the user account is created. See xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-group[group (optional) - Create User Group]. +[option]#--groups=#:: In addition to the default group, a comma separated list of group names the user should belong to. The groups must exist before the user account is created. See xref:sect-kickstart-commands-group[group (optional) - Create User Group]. [option]#--homedir=#:: The home directory for the user. If not provided, this defaults to `/home/pass:attributes[{blank}]_username_pass:attributes[{blank}]`. @@ -1948,7 +1948,7 @@ This command configures the [application]*kdump* kernel crash dumping mechanism. [NOTE] ==== -The syntax for this command is unusual because it is an add-on rather than a built-in Kickstart command. For more information about add-ons, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-addon[%addon (optional) - Include an Anaconda Add-on]. +The syntax for this command is unusual because it is an add-on rather than a built-in Kickstart command. For more information about add-ons, see xref:sect-kickstart-commands-addon[%addon (optional) - Include an Anaconda Add-on]. ==== @@ -2015,7 +2015,7 @@ For other completion methods, see the [command]#halt#, [command]#reboot#, and [c [[sect-kickstart-commands-reboot]] === reboot (optional) - Reboot After Installation -Reboot after the installation is successfully completed. If you are installing {PRODUCT} on IBM System{nbsp}z in command line mode (using xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-cmdline[cmdline (optional) - Perform Installation in Command Line Mode]), this command is necessary for a fully automated installation. +Reboot after the installation is successfully completed. If you are installing {PRODUCT} on IBM System{nbsp}z in command line mode (using xref:sect-kickstart-commands-cmdline[cmdline (optional) - Perform Installation in Command Line Mode]), this command is necessary for a fully automated installation. For other completion methods, see the [command]#halt#, [command]#poweroff#, and [command]#shutdown# Kickstart options. @@ -2056,7 +2056,7 @@ For more information about [application]*Anaconda* add-ons, see the link:++https [[sect-kickstart-commands-anaconda]] ==== %anaconda (optional) - Additional Anaconda Configuration -This section, introduced in {PRODUCT} 22, is used to specify additional configuration options for the installer. Commands inside this section only control the behavior during installation, not on the installed system. The only command currently available inside this section is xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-pwpolicy[pwpolicy (optional) - Change the Default Password Policy]. The [command]#%anaconda# section must end with `%end`. +This section, introduced in {PRODUCT} 22, is used to specify additional configuration options for the installer. Commands inside this section only control the behavior during installation, not on the installed system. The only command currently available inside this section is xref:sect-kickstart-commands-pwpolicy[pwpolicy (optional) - Change the Default Password Policy]. The [command]#%anaconda# section must end with `%end`. In interactive installations (using the graphical or text interface), the `/usr/share/anaconda/interactive-defaults.ks` file contains the default [command]#%anaconda# section. To change the defaults, you must create a `product.img` file with a Kickstart file replacing the default one, and pass this file to [application]*Anaconda* using a boot option. @@ -2070,7 +2070,7 @@ Use the [command]#%include _/path/to/file_pass:attributes[{blank}]# command to i [[sect-kickstart-commands-ksappend]] ==== %ksappend (optional) - Append Contents of Another File -The [command]#%ksappend _url_pass:attributes[{blank}]# directive is very similar to xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-include[%include (optional) - Include Contents of Another File] in that it is used to include the contents of additional files as though they were at the location of the [command]#%ksappend# command. The difference is in when the two directives are processed. +The [command]#%ksappend _url_pass:attributes[{blank}]# directive is very similar to xref:sect-kickstart-commands-include[%include (optional) - Include Contents of Another File] in that it is used to include the contents of additional files as though they were at the location of the [command]#%ksappend# command. The difference is in when the two directives are processed. [command]#%ksappend# is processed in an initial pass, before any other part of the Kickstart file. Then, this expanded Kickstart file is passed to the rest of [application]*Anaconda* where all [command]#%pre# scripts are handled, and then finally the rest of the Kickstart file is processed in order, which includes [command]#%include# directives. @@ -2097,7 +2097,7 @@ To install a 32-bit package on a 64-bit system, you will need to append the pack [IMPORTANT] ==== -[application]*Initial Setup* does not run after a system is installed from a Kickstart file unless a desktop environment and the [application]*X Window System* were included in the installation and graphical login was enabled. This means that by default, no users except for `root` will be created. You can either create a user with the [option]#user# option in the Kickstart file before installing additional systems from it (see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-user[user (optional) - Create User Account] for details) or log into the installed system with a virtual console as `root` and add users with the [command]#useradd# command. +[application]*Initial Setup* does not run after a system is installed from a Kickstart file unless a desktop environment and the [application]*X Window System* were included in the installation and graphical login was enabled. This means that by default, no users except for `root` will be created. You can either create a user with the [option]#user# option in the Kickstart file before installing additional systems from it (see xref:sect-kickstart-commands-user[user (optional) - Create User Account] for details) or log into the installed system with a virtual console as `root` and add users with the [command]#useradd# command. ==== @@ -2246,7 +2246,7 @@ The following options can be used to change the behavior of pre-installation scr [command]#%pre --log=/mnt/sysimage/root/ks-pre.log# ---- -For an example of a pre-installation script, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-pre-script[Example Pre-installation Script]. +For an example of a pre-installation script, see xref:sect-kickstart-example-pre-script[Example Pre-installation Script]. [[sect-kickstart-postinstall]] ==== %post (optional) - Post-installation Script @@ -2311,7 +2311,7 @@ with [option]#--nochroot#: [command]#%post --nochroot --log=/mnt/sysimage/root/ks-post.log# ---- -For an example of a post-installation script, see xref:Kickstart_Syntax_Reference.adoc#sect-kickstart-example-post-script[Example Post-installation Script]. +For an example of a post-installation script, see xref:sect-kickstart-example-post-script[Example Post-installation Script]. [[sect-kickstart-examples]] == Example Kickstart Configurations diff --git a/modules/install-guide/pages/install/Installing_Using_Anaconda.adoc b/modules/install-guide/pages/install/Installing_Using_Anaconda.adoc index 2b493cc..4d53ace 100644 --- a/modules/install-guide/pages/install/Installing_Using_Anaconda.adoc +++ b/modules/install-guide/pages/install/Installing_Using_Anaconda.adoc @@ -112,7 +112,7 @@ You can also control the graphical installer with your keyboard. Use kbd:[Tab] a Additionally, elements in each screen can be toggled using their respective shortcuts. These shortcuts are highlighted (underlined) when you hold down the kbd:[Alt] key; to toggle that element, press kbd:[Alt + _X_pass:attributes[{blank}]], where _X_ is the highlighted letter. -Your current keyboard layout is displayed in the top right hand corner. Only one layout is configured by default; if you configure more than layout in the `Keyboard Layout` screen (xref:Installing_Using_Anaconda.adoc#sect-installation-gui-keyboard-layout[Keyboard Layout]), you can switch between them by clicking the layout indicator. +Your current keyboard layout is displayed in the top right hand corner. Only one layout is configured by default; if you configure more than layout in the `Keyboard Layout` screen (xref:sect-installation-gui-keyboard-layout[Keyboard Layout]), you can switch between them by clicking the layout indicator. include::{partialsdir}/install/WelcomeSpoke.adoc[] diff --git a/modules/install-guide/pages/install/Troubleshooting.adoc b/modules/install-guide/pages/install/Troubleshooting.adoc index cdf8092..b176359 100644 --- a/modules/install-guide/pages/install/Troubleshooting.adoc +++ b/modules/install-guide/pages/install/Troubleshooting.adoc @@ -54,7 +54,7 @@ If the installation fails, the messages from these files are consolidated into ` [[sect-troubleshooting-transferring-logs]] === Transferring Log Files from the Installation System -All of the files described in xref:install/Troubleshooting.adoc#sect-troubleshooting-log-files[Log Files Generated During the Installation] reside in the installation program's RAM disk, which means they are not saved permamently and will be lost once the system is powered down. To store them permanently, copy those files to another system on the network using [command]#scp# on the system running the installation program, or copy them to a mounted storage device (such as an USB flash drive). Details on how to transfer the log files are below. Note that if you use an USB flash drive or other removable media, you should make sure to back up any data on it before starting the procedure. +All of the files described in xref:install/sect-troubleshooting-log-files[Log Files Generated During the Installation] reside in the installation program's RAM disk, which means they are not saved permamently and will be lost once the system is powered down. To store them permanently, copy those files to another system on the network using [command]#scp# on the system running the installation program, or copy them to a mounted storage device (such as an USB flash drive). Details on how to transfer the log files are below. Note that if you use an USB flash drive or other removable media, you should make sure to back up any data on it before starting the procedure. [[sect-troubleshooting-transferring-logs-usb]] ==== Transferring Log Files Onto a USB Drive From f42f44cee6354d4cc62b4235789c2cd64c2d204a Mon Sep 17 00:00:00 2001 From: Didik Supriadi Date: May 11 2020 15:38:34 +0000 Subject: [PATCH 2/3] Fix link to the intended reference --- diff --git a/modules/install-guide/pages/advanced/Boot_Options.adoc b/modules/install-guide/pages/advanced/Boot_Options.adoc index 7e0c5a2..7f0fe46 100644 --- a/modules/install-guide/pages/advanced/Boot_Options.adoc +++ b/modules/install-guide/pages/advanced/Boot_Options.adoc @@ -184,7 +184,7 @@ The _value_ parameter can be any of the following: + If this option is not specified, [application]*Anaconda* will use `provider_fedora_geoip`. -[option]#inst.keymap=#:: Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the [command]#keyboard# Kickstart command as described in xref:appendixes/Kickstart_Syntax_Reference.adoc#appe-kickstart-syntax-reference[Kickstart Syntax Reference]. +[option]#inst.keymap=#:: Specifies the keyboard layout to be used by the installation program. Layout codes are the same as the ones used in the [command]#keyboard# Kickstart command as described in xref:appendixes/Kickstart_Syntax_Reference.adoc#sect-kickstart-commands-keyboard[keyboard (optional) - Configure Keyboard Layouts]. [option]#inst.text#:: Forces the installation program to run in text mode instead of graphical mode. The text user interface is limited, for example, it does not allow you to modify the partition layout or set up LVM. When installing a system on a machine with a limited graphical capabilities, it is recommended to use VNC as described in xref:sect-boot-options-vnc[Enabling Remote Access Using VNC]. From a17b41930cd430d7bea8084747d2c7254fc99fc4 Mon Sep 17 00:00:00 2001 From: Didik Supriadi Date: May 11 2020 15:38:34 +0000 Subject: [PATCH 3/3] fix another xrefs in Troubleshooting.adoc --- diff --git a/modules/install-guide/pages/install/Troubleshooting.adoc b/modules/install-guide/pages/install/Troubleshooting.adoc index b176359..5140d7d 100644 --- a/modules/install-guide/pages/install/Troubleshooting.adoc +++ b/modules/install-guide/pages/install/Troubleshooting.adoc @@ -54,7 +54,7 @@ If the installation fails, the messages from these files are consolidated into ` [[sect-troubleshooting-transferring-logs]] === Transferring Log Files from the Installation System -All of the files described in xref:install/sect-troubleshooting-log-files[Log Files Generated During the Installation] reside in the installation program's RAM disk, which means they are not saved permamently and will be lost once the system is powered down. To store them permanently, copy those files to another system on the network using [command]#scp# on the system running the installation program, or copy them to a mounted storage device (such as an USB flash drive). Details on how to transfer the log files are below. Note that if you use an USB flash drive or other removable media, you should make sure to back up any data on it before starting the procedure. +All of the files described in xref:sect-troubleshooting-log-files[Log Files Generated During the Installation] reside in the installation program's RAM disk, which means they are not saved permamently and will be lost once the system is powered down. To store them permanently, copy those files to another system on the network using [command]#scp# on the system running the installation program, or copy them to a mounted storage device (such as an USB flash drive). Details on how to transfer the log files are below. Note that if you use an USB flash drive or other removable media, you should make sure to back up any data on it before starting the procedure. [[sect-troubleshooting-transferring-logs-usb]] ==== Transferring Log Files Onto a USB Drive