Updated documentation according to review

Chnaged documentation based on suggests in the PR review by Robert
Morrison.
This commit is contained in:
Ethan Smith-Coss 2021-06-23 11:26:17 +01:00
parent a68ac1cbac
commit f2ca9217ba
3 changed files with 13 additions and 14 deletions

View File

@ -12,8 +12,7 @@ DISCLAIMER: Currently this program can only update the Beta release of Microsoft
Options:
-nn, --no-notify Prevent notifications from being set after a session.
--mode= Set the mode of the program to be ran in. Default mode
occurs without this flag.
--mode= Set the mode of the program to be ran in. Default mode occurs without this flag.
* debug - run program in debug mode.
-y, --yes-all Assume yes to all yes/no decisions.
-v, --version Print out the version of the script and exit.

View File

@ -94,7 +94,7 @@ coreutils (>=8.32)
.IP \[bu] 2
binutils (>=2.35.1)
.IP \[bu] 2
procps
procps (only Busybox\-based systems)
.SH FILES
.IP \[bu] 2
\f[C]source.list\f[R] \[em]
@ -120,27 +120,27 @@ information.
This line can be broken into 4 parts
.RS 2
.IP "1." 3
\f[C][dists=amd64]\f[R] \-
\f[C][dists=amd64]\f[R] \[em]
.PD 0
.P
.PD
This tells the updater which package architecture it should download for
the system.
.IP "2." 3
\f[C]<https URL>\f[R] \-
\f[C]<https URL>\f[R] \[em]
.PD 0
.P
.PD
The URL which points to the distribution repository on the Microsoft
Packages server.
.IP "3." 3
\f[C]main\f[R] \-
\f[C]main\f[R] \[em]
.PD 0
.P
.PD
The main branch of the distribution repository.
.IP "4." 3
\f[C]stable\f[R] \-
\f[C]stable\f[R] \[em]
.PD 0
.P
.PD
@ -237,7 +237,7 @@ Consult the logs to identify which command returned the exit code.
Ethan Smith\-Coss
.SH CONTRIBUTORS
.IP \[bu] 2
Robert Morrison \- Documentation
Robert Morrison \[em] Documentation
.SS Contacting
.PP
All contacts should be done through Issues on Gitea.

View File

@ -66,7 +66,7 @@ Kernel version 5.11.21-179 and later.
* tar
* coreutils (>=8.32)
* binutils (>=2.35.1)
* procps
* procps (only Busybox-based systems)
# FILES
* `source.list`
@ -81,15 +81,15 @@ Kernel version 5.11.21-179 and later.
* `[dists]`
Most iconic line and resembles that of an APT entry for package information.
This line can be broken into 4 parts
1. `[dists=amd64]` -
1. `[dists=amd64]`
This tells the updater which package architecture it
should download for the system.
2. `<https URL>` -
2. `<https URL>`
The URL which points to the distribution repository
on the Microsoft Packages server.
3. `main` -
3. `main`
The main branch of the distribution repository.
4. `stable` -
4. `stable`
The type of release that should be installed to the system.
* `[pool]`
The prefix URL to the repository end-point that stores the latest releases.
@ -136,7 +136,7 @@ Kernel version 5.11.21-179 and later.
* Ethan Smith-Coss
# CONTRIBUTORS
* Robert Morrison - Documentation
* Robert Morrison Documentation
## Contacting
All contacts should be done through Issues on Gitea.