hank-test/quick-docs
1
0
Fork 0
mirror of https://pagure.io/fedora-docs/quick-docs.git synced 2024-10-19 01:35:42 +00:00
Code Issues 1 Projects Releases Packages Wiki Activity Actions

Address comments in pull request

Browse source
This commit is contained in:
Jared Smith 2018-02-27 12:05:41 -05:00
parent 595da07ffb
commit 35f4fa4f1f
3 changed files with 61 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
en-US/anaconda/anaconda.adoc
View file

@ -60,7 +60,7 @@ Past discussions of patches can be found in the https://lists.fedorahosted.org/p
[id="irc"] [id="irc"]
== IRC == IRC
There is also an IRC channel on http://freenode.net. There is also an IRC channel on link:http://freenode.net[FreeNode].
This resource is for discussion of Anaconda development, not for distribution customization questions. This resource is for discussion of Anaconda development, not for distribution customization questions.
[id="how-to-contribute"] [id="how-to-contribute"]
@ -90,8 +90,8 @@ Familiarize yourself with the tools that Anaconda uses.
Check out the following external reference documents: Check out the following external reference documents:
* https://developer.gnome.org/gtk3/stable/[GTK+ reference] * https://developer.gnome.org/gtk3/stable/[GTK+ reference]
* https://docs.python.org/2/tutorial/[Python tutorial] * https://docs.python.org/3/tutorial/[Python tutorial]
* https://docs.python.org/2/py-modindex.html[Python module reference] * https://docs.python.org/3/py-modindex.html[Python module reference]
[id="getting-the-source"] [id="getting-the-source"]
== Getting the Source == Getting the Source
@ -107,6 +107,8 @@ $ dnf install git
Note that several related packages will be installed as well. Note that several related packages will be installed as well.
After the git source code management tool has been installed, then you use anonymous git access to the Anaconda repository. After the git source code management tool has been installed, then you use anonymous git access to the Anaconda repository.
If you would just like to browse the Anaconda git repository via the web, then please use the following https://github.com/rhinstaller/anaconda.git[Anaconda git URL].
[source,bash] [source,bash]
---- ----
$ git clone https://github.com/rhinstaller/anaconda.git $ git clone https://github.com/rhinstaller/anaconda.git
@ -131,6 +133,7 @@ Checking 543 files out...
---- ----
If you have committer access to Anaconda, then you will want to use the git+ssh access url. If you have committer access to Anaconda, then you will want to use the git+ssh access url.
(GitHub also supports pushing changes via HTTPS, but may require you to re-authenticate every time you push your changes.)
[source,bash] [source,bash]
---- ----
@ -144,7 +147,6 @@ Once you've committed changes locally, you can push them with
$ git push $ git push
---- ----
If you would just like to browse the Anaconda git repository via the web, then please use the following https://github.com/rhinstaller/anaconda.git[Anaconda git URLs].
Anaconda has an https://github.com/rhinstaller/kickstart-tests[extensive suite of tests] that is still growing. Anaconda has an https://github.com/rhinstaller/kickstart-tests[extensive suite of tests] that is still growing.
If you contribute new functionality, it's good practice to include some tests along with that. If you contribute new functionality, it's good practice to include some tests along with that.
@ -163,8 +165,10 @@ Also try searching bugzilla for other reports about your problem, as some bugs a
The https://fedoraproject.org/wiki/Anaconda/AnacondaBugWorkflow[Anaconda Bug Workflow] explains how Fedora Anaconda bugs pass through bugzilla, and what all the various statuses really mean. The https://fedoraproject.org/wiki/Anaconda/AnacondaBugWorkflow[Anaconda Bug Workflow] explains how Fedora Anaconda bugs pass through bugzilla, and what all the various statuses really mean.
This is *only* for Fedora. This is *only* for Fedora.
Additionally, you can use this link:https://bugzilla.redhat.com/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&classification=Fedora&component=anaconda&list_id=8454223&product=Fedora&query_format=advanced[Bugzilla query] to find all open Anaconda bugs.
[id="design"] [id="design"]
Design Design
~~~~~~ ~~~~~~
* link:https://fedoraproject.org/wiki/How_to_Create_an_Anaconda_Banner[How to Create an Anaconda Banner] link:https://fedoraproject.org/wiki/How_to_Create_an_Anaconda_Banner[How to Create an Anaconda Banner]

51
en-US/anaconda/anaconda_logging.adoc
View file

@ -15,20 +15,25 @@ This includes:
== Logging on the installed system == Logging on the installed system
During the installation the logs are stored in the `/tmp` directory: During the installation the logs are stored in the `/tmp` directory:
* `/tmp/anaconda.log`, the general installation information, particularly the step changes. === Log files
* `/tmp/storage.log`, storage devices scan and manipulation (hard drives, partitions, LVM, RAID), partitioning
* `/tmp/program.log`, calls to external programs, their output `/tmp/anaconda.log`:: the general installation information, particularly the step changes.
* `/tmp/syslog`, messages from kernel and external programs (Network Manager) `/tmp/storage.log`:: storage devices scan and manipulation (hard drives, partitions, LVM, RAID), partitioning
* `/tmp/yum.log`, yum's internal log `/tmp/program.log`:: calls to external programs, their output
* `/tmp/dnf.log`, link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s internal log `/tmp/syslog`:: messages from kernel and external programs (Network Manager)
* `/tmp/dnf.hawkey.log`, link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s Hawkey internal log `/tmp/yum.log`:: yum's internal log
* `/tmp/dnf.rpm.log`, link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s RPM internal log `/tmp/dnf.log`:: link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s internal log
`/tmp/dnf.hawkey.log`:: link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s Hawkey internal log
`/tmp/dnf.rpm.log`:: link:http://www.fedoraproject.org/wiki/Dnf[DNF]'s RPM internal log
Certain log messages are also written to the terminals: Certain log messages are also written to the terminals:
* `/dev/tty3`, messages from `anaconda.log`, `storage.log` and `yum.log`. === TTY devices
* `/dev/tty4`, same as `syslog`
* `/dev/tty5`, stdout and stderr from external programs + `/dev/tty3`:: messages from `anaconda.log`, `storage.log` and `yum.log`.
`/dev/tty4`:: same as `syslog`
`/dev/tty5`:: stdout and stderr from external programs +
`tty3` and `tty4` reflect certain log files. `tty3` and `tty4` reflect certain log files.
Log files always contain messages from all the loglevels, including debug, but the minimal loglevel on the terminals can be controlled with the `loglevel` link:https://anaconda-installer.readthedocs.io/en/latest/boot-options.html#inst-loglevel[command line option]. Log files always contain messages from all the loglevels, including debug, but the minimal loglevel on the terminals can be controlled with the `loglevel` link:https://anaconda-installer.readthedocs.io/en/latest/boot-options.html#inst-loglevel[command line option].
@ -172,23 +177,23 @@ You should start seeing raw logs in the terminal once the guest machine starts b
=== See also === See also
* link:http://fedoraproject.org/wiki/Features/VirtioSerial[VirtioSerial] * link:http://fedoraproject.org/wiki/Features/VirtioSerial[VirtioSerial]
* [http://wiki.libvirt.org/page/Virtio Virtio at the libvirt wiki] * link:http://wiki.libvirt.org/page/Virtio[Virtio at the libvirt wiki]
* link:http://libvirt.org/formatdomain.html#elementsConsole[libvirt domain XML format] * link:http://libvirt.org/formatdomain.html#elementsConsole[libvirt domain XML format]
== Anaconda logs on the running system == Anaconda logs on the running system
After every successful installation, anaconda logs are copied into `/var/log` on the system you just installed. After every successful installation, anaconda logs are copied into `/var/log` on the system you just installed.
To avoid name clashes with other log files there, the anaconda logs are renamed: To avoid name clashes with other log files there, the anaconda logs are renamed:
[options="header"] [%header,cols=2*]
|==== |====
| Name during installation | Name on the target system | | Name during installation | Name on the target system
| `/tmp/anaconda.log` | `/var/log/anaconda.log` | | `/tmp/anaconda.log` | `/var/log/anaconda.log`
| `/tmp/syslog` | `/var/log/anaconda.syslog` | | `/tmp/syslog` | `/var/log/anaconda.syslog`
| `/tmp/X.log` | `/var/log/anaconda.xlog` | | `/tmp/X.log` | `/var/log/anaconda.xlog`
| `/tmp/program.log` | `/var/log/anaconda.program.log` | | `/tmp/program.log` | `/var/log/anaconda.program.log`
| `/tmp/storage.log` | `/var/log/anaconda.storage.log` | | `/tmp/storage.log` | `/var/log/anaconda.storage.log`
| `/tmp/yum.log` | `/var/log/anaconda.yum.log` | | `/tmp/yum.log` | `/var/log/anaconda.yum.log`
| `/tmp/ifcfg.log` (new in F14) | not copied | | `/tmp/ifcfg.log` (new in F14) | not copied
|==== |====
Starting with Fedora 15 (or post F14 Rawhide), the logs go to `/var/log/anaconda` directory on the target system, including ifcfg.log inroduced in F14. Starting with Fedora 15 (or post F14 Rawhide), the logs go to `/var/log/anaconda` directory on the target system, including ifcfg.log inroduced in F14.
@ -223,7 +228,3 @@ on guest:
ifconfig eth0 10.0.2.10/24 up ifconfig eth0 10.0.2.10/24 up
grep "" /tmp/syslog > /dev/tcp/10.0.2.2/4444 grep "" /tmp/syslog > /dev/tcp/10.0.2.2/4444
---- ----
== To do
* The current list of logging requirements and tasks is maintained in bugzilla [https://bugzilla.redhat.com/show_bug.cgi?id=524980 524980].
* A support for KVM's virtio logging is coming later [https://bugzilla.redhat.com/show_bug.cgi?id=576439 576439].

45
en-US/anaconda/anaconda_updates.adoc
View file

@ -39,6 +39,7 @@ You can also put an `updates.img` on a block device (either a floppy or a USB ke
This can be done only with an ext2 filesystem type of updates.img. This can be done only with an ext2 filesystem type of updates.img.
For a floppy drive, insert your floppy and then run For a floppy drive, insert your floppy and then run
[source,bash]
---- ----
$ dd if=updates.img of=/dev/fd0 bs=72k count=20 $ dd if=updates.img of=/dev/fd0 bs=72k count=20
---- ----
@ -75,6 +76,7 @@ The automatic tools shipped with Anaconda deal in the second form, so that's wha
The easiest way to create an image is to run The easiest way to create an image is to run
[source,bash]
---- ----
$ ./configure $ ./configure
$ make updates $ make updates
@ -85,6 +87,7 @@ This will package up all the changes to the tree since the last release and crea
Remember to use the correct git branch for the Fedora release you are working on or testing. Remember to use the correct git branch for the Fedora release you are working on or testing.
If you need finer control over this process (like creating an image from an even older release), or you don't want to run ./configure first (the make command will fail unless ./configure has been run), run If you need finer control over this process (like creating an image from an even older release), or you don't want to run ./configure first (the make command will fail unless ./configure has been run), run
[source,bash]
---- ----
$ scripts/makeupdates $ scripts/makeupdates
---- ----
@ -96,6 +99,7 @@ An `updates.img` can include more than just files from anaconda, though.
It can also include shared libraries, graphics, other python modules, and certain data files used by anaconda. It can also include shared libraries, graphics, other python modules, and certain data files used by anaconda.
To add files to an existing image (or create an entirely new one), just do the following: To add files to an existing image (or create an entirely new one), just do the following:
[source,bash]
---- ----
$ scripts/upd-updates updates.img file1 file2 ... $ scripts/upd-updates updates.img file1 file2 ...
---- ----
@ -106,6 +110,7 @@ For instance, python modules must be in their proper subdirectory mirroring the
Another way to create an image containing files outside of Anaconda is to create the required filesystem structure and compress it manually. Another way to create an image containing files outside of Anaconda is to create the required filesystem structure and compress it manually.
For example, let's say you want to overwrite some configuration file in `/etc`: For example, let's say you want to overwrite some configuration file in `/etc`:
[source,bash]
---- ----
$ mkdir -p updates/etc/ $ mkdir -p updates/etc/
$ cp my.cfg updates/etc/ $ cp my.cfg updates/etc/
@ -119,12 +124,14 @@ $ cd ..
`updates.img` files provided by the Fedora project and generated by the makeupdates script are compressed cpio archives. `updates.img` files provided by the Fedora project and generated by the makeupdates script are compressed cpio archives.
To examine one of these files, use `lsinitrd`: To examine one of these files, use `lsinitrd`:
[source,bash]
---- ----
$ lsinitrd updates.img $ lsinitrd updates.img
---- ----
To explode one, do the following: To explode one, do the following:
[source,bash]
---- ----
$ mkdir dest $ mkdir dest
$ cd dest $ cd dest
@ -135,25 +142,25 @@ $ gunzip -dc /path/to/updates.img | cpio -id
=== Available Options === Available Options
---- ----
usage: makeupdates [-h] [-k] [-c] [-t TAG] [-o OFFSET] [-p] usage: makeupdates [-h] [-k] [-c] [-t TAG] [-o OFFSET] [-p]
[-a PATH_TO_RPM [PATH_TO_RPM ...]] [-f ARCH] [-b BUILDDIR] [-a PATH_TO_RPM [PATH_TO_RPM ...]] [-f ARCH] [-b BUILDDIR]
Make Anaconda updates image Make Anaconda updates image
optional arguments: optional arguments:
-h, --help show this help message and exit -h, --help show this help message and exit
-k, --keep do not delete updates subdirectory -k, --keep do not delete updates subdirectory
-c, --compile compile code if there are isys changes -c, --compile compile code if there are isys changes
-t TAG, --tag TAG make updates image from TAG to HEAD -t TAG, --tag TAG make updates image from TAG to HEAD
-o OFFSET, --offset OFFSET -o OFFSET, --offset OFFSET
make image from (latest_tag - OFFSET) to HEAD make image from (latest_tag - OFFSET) to HEAD
-p, --po update translations -p, --po update translations
-a PATH_TO_RPM [PATH_TO_RPM ...], --add PATH_TO_RPM [PATH_TO_RPM ...] -a PATH_TO_RPM [PATH_TO_RPM ...], --add PATH_TO_RPM [PATH_TO_RPM ...]
add contents of RPMs to the updates image add contents of RPMs to the updates image
-f ARCH, --fetch ARCH -f ARCH, --fetch ARCH
autofetch new dependencies from Koji for ARCH autofetch new dependencies from Koji for ARCH
-b BUILDDIR, --builddir BUILDDIR -b BUILDDIR, --builddir BUILDDIR
build directory for shared objects build directory for shared objects
---- ----
=== Including Updates for an Older Installation Image === Including Updates for an Older Installation Image