Skip to content

Commit 6ab6d28

Browse files
lvicounlvicoun
authored
Merge pull request #265 from SUSE/jhalackova_separating_tr-up
Jhalackova separating tr up
2 parents 4c98baa + a0b26b9 commit 6ab6d28

4 files changed

Lines changed: 243 additions & 27 deletions

File tree

‎DC-transactional-updates-marble‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# This file originates from the project https://github.com/openSUSE/doc-kit
2+
# This file can be edited downstream.
3+
4+
MAIN="transactional-updates.asm.xml"
5+
# Point to the ID of the <structure> of your assembly
6+
ROOTID="transactional-updates"
7+
SRC_DIR="articles"
8+
IMG_SRC_DIR="images"
9+
PROFOS="slemicro"
10+
11+
PROFCONDITION="suse-product"
12+
#PROFCONDITION="suse-product;beta"
13+
14+
15+
STYLEASSEMBLY="/usr/share/xml/docbook/stylesheet/nwalsh5/current/assembly/assemble.xsl"
16+
17+
STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
18+
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"

‎articles/transactional-updates.asm.xml‎

Lines changed: 207 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,207 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
3+
<!-- This file can be edited downstream. -->
4+
<!DOCTYPE assembly
5+
[
6+
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
7+
%entities;
8+
]>
9+
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
10+
<!-- point back to this document with a similar comment added to your legacy doc piece -->
11+
<!-- refer to README.md for file and id naming conventions -->
12+
<assembly version="5.2" xml:lang="en"
13+
xmlns:xlink="http://www.w3.org/1999/xlink"
14+
xmlns:trans="http://docbook.org/ns/transclusion"
15+
xmlns:its="http://www.w3.org/2005/11/its"
16+
xmlns="http://docbook.org/ns/docbook">
17+
<!-- resources section references all topic chunks used in the final article
18+
-->
19+
<!-- R E S O U R C E S -->
20+
21+
<!-- Concept files -->
22+
<resources>
23+
<resource xml:id="_transactional-update" href="../concepts/transactional-update.xml">
24+
<description>About &tr-up;</description>
25+
</resource>
26+
</resources>
27+
<!-- Tasks -->
28+
<resources>
29+
<resource xml:id="_transactional-update-rollback" href="../tasks/transactional-update-rollback.xml">
30+
<description>Performing rollback</description>
31+
</resource>
32+
33+
<resource xml:id="_transactional-update-no-reboot" href="../tasks/transactional-update-no-reboot.xml">
34+
<description>Performing changes without rebooting the system</description>
35+
</resource>
36+
<resource xml:id="_transactional-update-cleanup" href="../tasks/transactional-update-cleanup.xml">
37+
<description>Snapshots cleanup</description>
38+
</resource>
39+
<resource xml:id="_transactional-update-automatic-updates" href="../tasks/transactional-update-automatic-updates.xml">
40+
<description>Automatic updates of the system</description>
41+
</resource>
42+
</resources>
43+
<!-- References -->
44+
<resources>
45+
<resource xml:id="_transactional-update-usage" href="../references/transactional-update-usage.xml">
46+
<description>Usage of &tr-up;</description>
47+
</resource>
48+
</resources>
49+
<!-- Legal -->
50+
<resources>
51+
<resource href="../common/legal.xml" xml:id="_legal">
52+
<description>Legal Notice</description>
53+
</resource>
54+
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
55+
<description>GNU Free Documentation License</description>
56+
</resource>
57+
</resources>
58+
<!-- S T R U C T U R E -->
59+
<structure renderas="article" xml:id="transactional-updates" xml:lang="en">
60+
<merge>
61+
<title>Administering &productnameshort; using the &tr-up; command</title>
62+
<!-- Create revision history to enable versioning; add most recent entries at the top. -->
63+
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
64+
<revhistory xml:id="rh-transactional-updates">
65+
<revision><date>2023-12-19</date>
66+
<revdescription>
67+
<itemizedlist>
68+
<!-- Group by type of change (added/removed/changed)-->
69+
<listitem><para>Initial version
70+
</para></listitem>
71+
72+
</itemizedlist>
73+
</revdescription>
74+
</revision>
75+
</revhistory>
76+
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
77+
<!-- add author's e-mail -->
78+
<meta name="maintainer" content="jsindelarova@suse.com" its:translate="no"/>
79+
<!-- ISO date of last update as YYYY-MM-DD -->
80+
<meta name="updated" content="2037-11-16" its:translate="no"/>
81+
<!-- this does not work yet. Use the dm tags listed below for now
82+
<meta name="bugtracker" its:translate="no">
83+
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
84+
<phrase role="component">Non-product-specific documentation</phrase>
85+
<phrase role="product">Smart Docs</phrase>
86+
<phrase role="assignee">assignee@suse.com</phrase>
87+
</meta>
88+
-->
89+
<!-- not supported, yet. Use dm: tag for now
90+
<meta name="translation" its:translate="no">
91+
<phrase role="trans">yes</phrase>
92+
<phrase role="language">de-de,cs-cz</phrase>
93+
</meta>
94+
-->
95+
<!-- enter the platform identifier or a list of
96+
identifiers, separated by ; -->
97+
<!-- For a full list of meta tags and their values,
98+
see https://confluence.suse.com/x/aQDWNg
99+
-->
100+
<meta name="architecture" content="x86;power" its:translate="no"/>
101+
<meta name="productname" its:translate="no">
102+
<!-- enter product name and version --><productname version="X.Y">&productname;</productname>
103+
</meta>
104+
<meta name="title" its:translate="yes">Usage of the &tr-up; command and its use cases.</meta>
105+
<meta name="description" its:translate="yes">From the command usage description to practical
106+
examples.</meta>
107+
<meta name="social-descr" its:translate="yes">Admnistration of &productnameshort; using the
108+
&tr-up; command.</meta>
109+
<!-- suitable category, comma-separated list of categories -->
110+
<meta name="category" content="Systems Management" its:translate="no"/>
111+
<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
112+
<dm:bugtracker>
113+
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
114+
<dm:component>Smart Docs</dm:component>
115+
<dm:product>Documentation</dm:product>
116+
<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
117+
<dm:assignee>jsindelarova@suse.com</dm:assignee>
118+
</dm:bugtracker>
119+
<dm:translation>yes</dm:translation>
120+
</dm:docmanager>
121+
<abstract>
122+
<variablelist>
123+
<varlistentry>
124+
<term>WHAT?</term>
125+
<listitem>
126+
<para>
127+
The &tr-up; command enables you to modify a read-only file system. The
128+
modifications are performed in a separate snapshot and do not influence the running
129+
system until you boot into the snapshot.
130+
</para>
131+
</listitem>
132+
</varlistentry>
133+
<varlistentry>
134+
<term>WHY?</term>
135+
<listitem>
136+
<para>
137+
You want to administer &productnameshort;.
138+
</para>
139+
</listitem>
140+
</varlistentry>
141+
<varlistentry>
142+
<term>EFFORT</term>
143+
<listitem>
144+
<para>
145+
It takes less than 30 minutes to understand the &tr-up; command.
146+
</para>
147+
</listitem>
148+
</varlistentry>
149+
<varlistentry>
150+
<term>GOAL</term>
151+
<listitem>
152+
<para>
153+
You will understand how the &tr-up; works and how you can use it to administer your system.
154+
</para>
155+
</listitem>
156+
</varlistentry>
157+
<varlistentry>
158+
<term>REQUIREMENTS</term>
159+
<listitem>
160+
<itemizedlist>
161+
<listitem>
162+
<para>
163+
A running instance of &productnameshort;
164+
</para>
165+
</listitem>
166+
<listitem>
167+
<para>
168+
&rootuser; privileges
169+
</para>
170+
</listitem>
171+
</itemizedlist>
172+
</listitem>
173+
</varlistentry>
174+
</variablelist>
175+
</abstract>
176+
</merge>
177+
<!-- pull in all the topic files you need -->
178+
<!-- pick the appropriate type of include to match your needs -->
179+
<!-- pull in a topic as is -->
180+
<module resourceref="_transactional-update" renderas="section">
181+
<module resourceref="_transactional-update-no-reboot" renderas="section"/>
182+
</module>
183+
184+
185+
<module resourceref="_transactional-update-usage" renderas="section">
186+
<module resourceref="_transactional-update-cleanup" renderas="section">
187+
<merge>
188+
<abstract>
189+
<para/>
190+
</abstract>
191+
</merge>
192+
</module>
193+
</module>
194+
<module resourceref="_transactional-update-rollback" renderas="section"/>
195+
<module resourceref="_transactional-update-automatic-updates" renderas="section">
196+
<merge>
197+
<abstract>
198+
<para/>
199+
</abstract>
200+
</merge>
201+
</module>
202+
<module resourceref="_legal"/>
203+
<module resourceref="_gfdl">
204+
<output renderas="appendix"/>
205+
</module>
206+
</structure>
207+
</assembly>

‎concepts/transactional-update.xml‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,24 @@
8989
</para>
9090
</listitem>
9191
</itemizedlist>
92-
<section xml:id="tr-up-environment">
93-
<title>Environment within transactional-update command</title>
94-
<para>
95-
Each time you run the &tr-up; command, the changes are performed in a
96-
new snapshot. The environment in the snapshot may differ from
97-
the one in the shell you run the &tr-up; command from. For example, the
98-
current working directory (<literal>$PWD</literal>) is not set to the
99-
directory from which you run the &tr-up;, but is set to
100-
<literal>/</literal>.
101-
</para>
102-
<para>
103-
From within the snapshot, you cannot access the
104-
<filename>/var</filename> directory. This directory is also not
105-
included in the snapshot as described in
106-
<xref linkend="snapshots-excluded-dirs"/>. However, some directories
107-
are not included in the snapshot but are accessible inside the &tr-up;
108-
environment, for example, the <filename>/root</filename> directory.
109-
</para>
11092
</section>
93+
<section xml:id="tr-up-environment">
94+
<title>Environment within the &tr-up; command</title>
95+
<para>
96+
Each time you run the &tr-up; command, the changes are performed in a
97+
new snapshot. The environment in the snapshot may differ from
98+
the one in the shell you run the &tr-up; command from. For example, the
99+
current working directory (<literal>$PWD</literal>) is not set to the
100+
directory from which you run the &tr-up;, but is set to
101+
<literal>/</literal>.
102+
</para>
103+
<para>
104+
From within the snapshot, you cannot access the
105+
<filename>/var</filename> directory. This directory is also not
106+
included in the snapshot. However, some directories
107+
are not included in the snapshot but are accessible inside the &tr-up;
108+
environment, for example, the <filename>/root</filename> directory.
109+
</para>
111110
</section>
112111
<!-- 2023-05-17 tbazant, not available any more
113112
<section xml:id="how-it-works-transactional-update-repositories">

‎tasks/transactional-update-no-reboot.xml‎

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -90,14 +90,6 @@
9090
snapshot. After you finish making changes to the file system and leave
9191
the shell with the <command>exit</command> command, you need to reboot
9292
the host to apply the changes.
93-
</para>
94-
<tip>
95-
<para>
96-
Another approach to making multiple changes to the file system without
97-
rebooting the host is to use the <option>--continue</option> option.
98-
For more details, refer to
99-
<xref linkend="transactional-update-continue" />.
100-
</para>
101-
</tip>
93+
</para>
10294
</section>
10395
</topic>

0 commit comments

Comments
 (0)