Skip to content

Commit

Permalink
Fix the documentation format
Browse files Browse the repository at this point in the history
  • Loading branch information
imobachgs committed Dec 21, 2023
1 parent 3a69c37 commit 2face4b
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/SELF_UPDATE.md
Expand Up @@ -66,7 +66,7 @@ and select the language from the list. Or use the `language` boot option, e.g.
`language=de_DE`.

If you want to use a different keyboard layout for the console then use the
[`keytable`](https://en.opensuse.org/SDB:Linuxrc#p_keytable) boot option.
[keytable](https://en.opensuse.org/SDB:Linuxrc#p_keytable) boot option.

## Network Setup

Expand Down
6 changes: 3 additions & 3 deletions doc/installation_overview.md
Expand Up @@ -16,7 +16,7 @@ to learn more about that. This document is mainly about `installation` and

Although _YaST_ sits at the central point of the installation process, it is
not the only software involved.
[_Linuxrc_](https://en.opensuse.org/SDB:Linuxrc), which will be started just
[Linuxrc](https://en.opensuse.org/SDB:Linuxrc), which will be started just
before _YaST_, is another key player.

_Linuxrc_ sets up the hardware and initializes the installation process. It can
Expand Down Expand Up @@ -108,7 +108,7 @@ at `/usr/lib/YaST2/startup/First-Stage`.
For _YaST_, the installation is now in the `initial`
[stage](https://github.com/yast/yast-yast2/blob/master/library/general/src/modules/Stage.rb).
At this point, the `installation` client relies on
[`inst_worker_initial`](src/clients/inst_worker_initial.rb). You could take a
[inst_worker_initial](src/clients/inst_worker_initial.rb). You could take a
look at the documentation about [installation
clients](doc/installation_clients.md) to learn more.

Expand Down Expand Up @@ -166,7 +166,7 @@ The scripts which perform these steps live in
#### inst_worker_continue

The client which drives the second stage is
[`inst_worker_continue`](src/clients/inst_worker_continue.rb). Of course, it
[inst_worker_continue](src/clients/inst_worker_continue.rb). Of course, it
relies on `ProductControl` as `inst_worker_initial` does.

### YaST2.call
Expand Down
2 changes: 1 addition & 1 deletion doc/memory-profile-valgrind-massif.md
Expand Up @@ -36,7 +36,7 @@ But to see names inside libraries Massif needs debuginfo files.

tl;dr: Boot with `extend=gdb MASSIF=1`.

1. Install Massif. It is part of the [**gdb** extension][gdb-ext], so use
1. Install Massif. It is part of the [gdb extension][gdb-ext], so use
`extend=gdb` at the boot prompt, or run `extend gdb` in an inst-sys shell.

2. Install Debuginfo. For Tumbleweed an automatic downloader is in place
Expand Down
12 changes: 6 additions & 6 deletions doc/url.md
@@ -1,6 +1,6 @@
# URL handling in the installer

*For a general description of URL formats see [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-3).*
For a general description of URL formats see [RFC 3986](https://www.rfc-editor.org/rfc/rfc3986#section-3).

## Absolute URLs

Expand All @@ -9,11 +9,11 @@ all can be traced to one of three backends:

1. [Linuxrc](https://en.opensuse.org/SDB:Linuxrc#Parameter_Reference)
2. [Zypp](https://doc.opensuse.org/projects/libzypp/HEAD/classzypp_1_1media_1_1MediaManager.html#MediaAccessUrl)
3. [YaST/AutoYaST](https://doc.opensuse.org/projects/autoyast/#Commandline-ay) itself in [`Yast::Transfer::FileFromUrl.get_file_from_url`](https://github.com/yast/yast-installation/blob/b950b062729d98d11d98609cba829bbc39355143/src/lib/transfer/file_from_url.rb#L76-L92)
3. [YaST/AutoYaST](https://doc.opensuse.org/projects/autoyast/#Commandline-ay) itself in [Yast::Transfer::FileFromUrl.get_file_from_url](https://github.com/yast/yast-installation/blob/b950b062729d98d11d98609cba829bbc39355143/src/lib/transfer/file_from_url.rb#L76-L92)

> There was additionally a 4th one hidden in AutoYaST:
>
> 4. [`Yast::ProfileLocationClass.Process`](https://github.com/yast/yast-autoinstallation/blob/SLE-15-SP4/src/modules/ProfileLocation.rb#L101-L116)
> 4. [Yast::ProfileLocationClass.Process](https://github.com/yast/yast-autoinstallation/blob/SLE-15-SP4/src/modules/ProfileLocation.rb#L101-L116)
> took care of the `label` scheme in AutoYaST context. It's been added to `Yast::Transfer::FileFromUrl` now.
## Relative URLs
Expand Down Expand Up @@ -141,7 +141,7 @@ end
There are often hidden assumptions in these regexps (e.g. that `relurl` starts with at least two slashes)
that might break things at some point.

But there is a perfectly fine [`URI`](https://docs.ruby-lang.org/en/master/URI.html) class
But there is a perfectly fine [URI](https://docs.ruby-lang.org/en/master/URI.html) class
in ruby that can do this better. For example:

```ruby
Expand All @@ -151,7 +151,7 @@ end
```

And there is also the
[`Yast::URLClass`](https://github.com/yast/yast-yast2/blob/master/library/types/src/modules/URL.rb)
[Yast::URLClass](https://github.com/yast/yast-yast2/blob/master/library/types/src/modules/URL.rb)
class for handling URLs. On the negative side this is old YCP code but on the
positive side it deals with idiosyncrasies like varying number of slashes.

Expand Down Expand Up @@ -182,7 +182,7 @@ def resolve_location
end
```

There is a [`Yast2::RelURL`](https://github.com/yast/yast-yast2/blob/master/library/general/src/lib/yast2/rel_url.rb) class that can do exactly that.
There is a [Yast2::RelURL](https://github.com/yast/yast-yast2/blob/master/library/general/src/lib/yast2/rel_url.rb) class that can do exactly that.

```ruby
Yast2::RelURL.new("http://example.com", "relurl://foo/bar").absolute_url.to_s
Expand Down
4 changes: 2 additions & 2 deletions doc/yupdate.md
Expand Up @@ -148,9 +148,9 @@ the start.
By default this will use port 8000, if the server uses another port just add
`:` followed by the port number.

*Note: Make sure the server port is open in the firewall configuration,
Note: Make sure the server port is open in the firewall configuration,
see the [documentation](https://github.com/yast/yast-rake/#server) for
more details.*
more details.

#### Patching Multiple Packages

Expand Down

0 comments on commit 2face4b

Please sign in to comment.