Run spellchecker on pages and corrected some inputs.
Emiliano Vavassori
parent
317f8bab1b
commit
3fc84e36dc
18
Batch.md
18
Batch.md
|
|
@ -33,16 +33,16 @@ built. `loaih` will honor the following key-value pairs:
|
|||
|
||||
* `download`: This is the name of the folder where all the needed archives
|
||||
would be downloaded to. Contrary to the `build` verb, using batch building
|
||||
will **conserve** all the downloads (except for daily and preleases). Defaults
|
||||
will **conserve** all the downloads (except for daily and prereleases). Defaults
|
||||
to `/var/tmp/downloads`;
|
||||
* `force`: disables the check for existing builds, thus forcing `loaih` to
|
||||
rebuild the entire set of AppImages described in the file. Defaults to
|
||||
`False` (so: check previous existence of the build and skip it if found);
|
||||
* `repo`: this is the "public available" storage where final builds would be
|
||||
published. It can be a local folder (and in this case it is referred as a
|
||||
"local" repo) or it can be an HTTP/HTTPS address (in which case this is
|
||||
considered as "remote" repo). See below under *Remote repositories* for more
|
||||
explanations. Defaults to `/srv/http/appimage`;
|
||||
"local" repository) or it can be an HTTP/HTTPS address (in which case this is
|
||||
considered as "remote" repository). See below under *Remote repositories* for
|
||||
more explanations. Defaults to `/srv/http/appimage`;
|
||||
* `remote_host`: the name of the remote host that can be reached via
|
||||
rsync/ssh (see below under *Remote repositories* for more information).
|
||||
Defaults to '';
|
||||
|
|
@ -60,13 +60,15 @@ AppImage:
|
|||
* `query`: the query to use when determining the version of the build (see
|
||||
[Usage - versions](Version.md) for a more complete explanation). This is a
|
||||
required parameter;
|
||||
* `language`: the set of locales to support, comma separated (e.g. 'en,it,de'), or one of the predefined set: *basic*, *standard* and *full*. Defaults to 'basic' if not specified;
|
||||
* `language`: the set of locales to support, comma separated (e.g.
|
||||
'en,it,de'), or one of the predefined set: *basic*, *standard* and *full*.
|
||||
Defaults to 'basic' if not specified;
|
||||
* `offline_help`: whether the AppImage should contain the help pages, defined
|
||||
as boolean value (true/false). Defaults to 'false' if not specified;
|
||||
* `portable`: whether the AppImage should be portable or not, defined as a
|
||||
boolean value (true/false). Defaults to 'false' if not specified.
|
||||
|
||||
## Expected behaviour ##
|
||||
## Expected behavior ##
|
||||
|
||||
For each of the items in the `builds` list, `loaih` does the following
|
||||
operations, in this order:
|
||||
|
|
@ -77,7 +79,7 @@ section);
|
|||
downloads the required archives;
|
||||
* based on the options of each object, it unpacks the needed archives, fixes
|
||||
the sources and builds the AppImage in a temporary folder;
|
||||
* proceeds to calculate md5 checksums of each new file;
|
||||
* proceeds to calculate MD5 checksums of each new file;
|
||||
* the built files are then moved to the publishing folder;
|
||||
* if needed, "generic" links to the last versions are produced and published,
|
||||
also (e.g. when the script has just finished building the just released 'fresh' version of LibreOffice, it would create the necessary `LibreOffice-fresh.*.AppImage*` links;
|
||||
|
|
@ -101,7 +103,7 @@ honoring the `remote_host` and `remote_path` key-pairs.
|
|||
|
||||
For this mechanism to work, please configure an `ssh_config` stanza for the
|
||||
host you will indicate in `remote_host` for the user you plan to use to build
|
||||
the AppImages with; also, ensure passwordless login can be performed (using
|
||||
the AppImages with; also, ensure password-less login can be performed (using
|
||||
SSH private/public key pairs).
|
||||
|
||||
---
|
||||
|
|
|
|||
15
Build.md
15
Build.md
|
|
@ -1,6 +1,6 @@
|
|||
# Manual builds #
|
||||
|
||||
`loaih build` can be used to build a single version of the AppImage.
|
||||
`loaih build` can be used to build a single version of the AppImage.
|
||||
|
||||
## CAVEATS ##
|
||||
|
||||
|
|
@ -10,13 +10,12 @@ commands (`build`, documented here, and `batch`, documented in the [relative
|
|||
page](Batch.md)) to achieve both results.
|
||||
|
||||
From version 1.3.3, additionally, the default values for the available options
|
||||
for the single build (`build` verb)
|
||||
have been *differentiated* and *simplified* from the ones available for the set of builds (`batch` verb).
|
||||
for the single build (`build` verb) have been *differentiated* and
|
||||
*simplified* from the ones available for the set of builds (`batch` verb).
|
||||
|
||||
Hopefully, the chosen defaults would require the lowest number of options to
|
||||
be passed to the `build` command.
|
||||
|
||||
|
||||
## Examples ##
|
||||
|
||||
loaih build daily
|
||||
|
|
@ -35,14 +34,14 @@ specified as `--sign`, so the previous command could have looked as:
|
|||
|
||||
loaih build 20231231 --updatable --languages standard
|
||||
|
||||
For the full description of all the available options and their relative default values, please check out the inline help for the `build` verb:
|
||||
For the full description of all the available options and their relative
|
||||
default values, please check out the inline help for the `build` verb:
|
||||
|
||||
loaih build --help
|
||||
|
||||
**PLEASE BE AWARE** that option names and short options have changed since
|
||||
v1.3.3, to the point this is indeed a **breaking change**.
|
||||
|
||||
|
||||
## Multiple single builds ##
|
||||
|
||||
Also the `build` verb supports multiple queries:
|
||||
|
|
@ -51,7 +50,7 @@ Also the `build` verb supports multiple queries:
|
|||
|
||||
There's a little caveat, though: if the AppImage names of the requested
|
||||
versions will overlap (e.g. `7.5,7.5.9.2`, both queries likely resulting in an
|
||||
AppImage filename of 'LibreOffice-7.5.9.2.basic-x86_64.AppImage'), only the
|
||||
AppImage file name of 'LibreOffice-7.5.9.2.basic-x86_64.AppImage'), only the
|
||||
result of the last query will survive the building process (all conflicting
|
||||
versions would be built, but the last one will likely overwrite the previous
|
||||
ones), unless the `-c`, `--check` option is used (and in this case, just the
|
||||
|
|
@ -61,7 +60,7 @@ first one will survive and the rest would be skipped).
|
|||
|
||||
If not specified otherwise, a normal run would build the AppImage in the
|
||||
directory in which the command has been run and it will download all the
|
||||
required files in a `downloads` subfolder, that will be created if missing and
|
||||
required files in a `downloads` sub-folder, that will be created if missing and
|
||||
removed entirely at the end of the build process (unless `-k` option is used -
|
||||
see below).
|
||||
|
||||
|
|
|
|||
24
Concepts.md
24
Concepts.md
|
|
@ -13,7 +13,7 @@ The single manual build is implemented with the `build` verb, while the
|
|||
batch/bulk builds is supported with the `batch` verb of the `loaih`
|
||||
command.
|
||||
Since the two use cases are largely different, when developing `loaih` we
|
||||
chose to distinguish the default behaviour of the options of the command based
|
||||
chose to distinguish the default behavior of the options of the command based
|
||||
on the verb.
|
||||
|
||||
The concepts behind the options available to both `build` and `batch` verbs
|
||||
|
|
@ -35,11 +35,11 @@ Or, you can provide a set of languages to include in a similar way:
|
|||
|
||||
loaih build daily -l 'pt,pt-BR'
|
||||
|
||||
The command recognises, also, three different sets of languages:
|
||||
The command recognizes, also, three different sets of languages:
|
||||
|
||||
* `basic`, which includes just English and British English;
|
||||
* `standard`, which includes English, Arabic, German, British English,
|
||||
Spanish, French, Japanese, Korean, Portuguese, Brasilian Portuguese,
|
||||
Spanish, French, Japanese, Korean, Portuguese, Brazilian Portuguese,
|
||||
Russian, Standard Chinese and Taiwanese Chinese;
|
||||
* `full`, which includes all the languages supported by LibreOffice at the
|
||||
time of the specific release.
|
||||
|
|
@ -56,7 +56,7 @@ option is `basic`.
|
|||
The `loaih` script will **not** include, by default, the offline help pages
|
||||
for the chosen release, for both the `build` and `batch` verbs.
|
||||
|
||||
However, you can change the behaviour of the `build` verb using the
|
||||
However, you can change the behavior of the `build` verb using the
|
||||
`--offline-help` option, or in short `-o`: when used, this option will honor
|
||||
the value of the `--languages` option and include the help pages for all the
|
||||
languages that have been selected by the user.
|
||||
|
|
@ -66,7 +66,7 @@ languages that have been selected by the user.
|
|||
Updatability for an AppImage means to provide support to use the
|
||||
[zsync2](https://github.com/AppImageCommunity/zsync2) utility to update a
|
||||
previously downloaded AppImage. This tool permits to avoid re-downloading the
|
||||
entire AppImage file, but to leverage the webserver to send only the different
|
||||
entire AppImage file, but to leverage the web server to send only the different
|
||||
chunks of the AppImage file from the local version.
|
||||
|
||||
Since the size of the AppImages are different based on language support,
|
||||
|
|
@ -74,7 +74,7 @@ offline help pages inclusion and so on, using `zsync2` to download a newly
|
|||
built image is not always beneficial.
|
||||
|
||||
For an AppImage to be updatable means that the newly built AppImage has to be
|
||||
publicly available on a web server that supports downlads in chunks, the
|
||||
publicly available on a web server that supports downloads in chunks, the
|
||||
presence in the same folder of the AppImage file of a specific `.zsync` file
|
||||
and the usage, by the final user, of the `zsync2` tool.
|
||||
|
||||
|
|
@ -82,14 +82,14 @@ By default, the `loaih` script **does not** build an updatable AppImage when
|
|||
using the `build` verb (manual build), however it does when using
|
||||
the `batch` verb instead.
|
||||
|
||||
To revert the default behaviour of the `build` verb, you can use the
|
||||
To revert the default behavior of the `build` verb, you can use the
|
||||
`--updatable` option (in short, `-u`), which forces `loaih` to build also the
|
||||
`.zsync` file required to update a previous AppImage.
|
||||
|
||||
## Portability ##
|
||||
|
||||
The `loaih` command can produce AppImages that uses a different profile path
|
||||
than the default LibreOffice one --- this is jergally known as "portable"
|
||||
The `loaih` command can produce an AppImage that uses a different profile path
|
||||
than the default LibreOffice one --- this is generally known as "portable"
|
||||
AppImage.
|
||||
|
||||
Portable versions greatly help when debugging an issue in a specific version
|
||||
|
|
@ -142,14 +142,14 @@ You can then check your built AppImage for example with:
|
|||
|
||||
When releasing a great number of similar AppImages, all starting from the same
|
||||
sources, as in the case of `batch` builds, keeping the downloads between
|
||||
single builds will allow a great deal of bandwith saving and, in general,
|
||||
single builds will allow a great deal of bandwidth saving and, in general,
|
||||
optimize the release process.
|
||||
|
||||
This is however a very different approach than when building a single version
|
||||
for your own purposes: you just need the built AppImage, and you don't care
|
||||
about the sources once the build process is finished.
|
||||
|
||||
This is reflected in the behaviour of the two verbs of `loaih`, where:
|
||||
This is reflected in the behavior of the two verbs of `loaih`, where:
|
||||
|
||||
* the `batch` verb will retain all the downloaded files;
|
||||
* the `build` verb instead will remove the download folder as soon as it is
|
||||
|
|
@ -162,7 +162,7 @@ want two slightly different versions of the same LibreOffice version as
|
|||
AppImage (for example, if you want a version with the help pages and one
|
||||
without).
|
||||
|
||||
If you want to customise the position inside your filesystem of the download
|
||||
If you want to customize the position inside your filesystem of the download
|
||||
folder, you can also use the option `--download-path` (in short `-d`). This is
|
||||
honored in any case, even if you don't want to keep your downloads after the
|
||||
build.
|
||||
|
|
|
|||
4
Home.md
4
Home.md
|
|
@ -2,7 +2,9 @@
|
|||
|
||||
## Introduction ##
|
||||
|
||||
`loaih` -- LibreOffice AppImage Helper -- is a small Python CLI utility to help build AppImages based on specific instructions regarding locale support, help pages and portability.
|
||||
`loaih` -- LibreOffice AppImage Helper -- is a small Python
|
||||
command-line-interface utility to help build AppImages based on specific
|
||||
instructions regarding locale support, help pages and portability.
|
||||
|
||||
### Table of contents ###
|
||||
|
||||
|
|
|
|||
|
|
@ -19,8 +19,8 @@ site](https://git.libreitalia.org/libreitalia/loaih/).
|
|||
|
||||
python3 setup.py bdist
|
||||
|
||||
4. If you have permissions (e.g. with `sudo`), you can install `loaih`
|
||||
system-wide:
|
||||
4. If you have permissions (e.g. by elevating privileges with `sudo`), you can
|
||||
install `loaih` system-wide:
|
||||
|
||||
sudo python3 setup.py install
|
||||
|
||||
|
|
@ -30,7 +30,7 @@ When a new version is released, a binary artifact of the package will be
|
|||
uploaded to this website in the [Release](https://git.libreitalia.org/libreitalia/loaih/releases)
|
||||
section.
|
||||
|
||||
1. Find the latest relaease in the
|
||||
1. Find the latest release in the
|
||||
[Release](https://git.libreitalia.org/libreitalia/loaih/releases) page and
|
||||
download the relative `.whl` file (e.g. `loaih-1.3.3-py3-none-any.whl`);
|
||||
2. Ensure you have the `wheel` package installed in your system:
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ repositories.
|
|||
|
||||
loaih getversion 5.4
|
||||
|
||||
to receive the following information:
|
||||
To receive the following information:
|
||||
|
||||
query: 5.4
|
||||
version: 5.4.7.2
|
||||
|
|
|
|||
Loading…
Reference in New Issue