diff options
author | Ali Mohammad Pur <ali.mpfard@gmail.com> | 2022-01-24 16:09:26 +0330 |
---|---|---|
committer | Andreas Kling <kling@serenityos.org> | 2022-01-27 23:01:05 +0100 |
commit | 66dcb0123ad9488eb8ecee20b6311e07fdf8c2c0 (patch) | |
tree | 46f57a3c787aae3222f2469dd4d24d8847cae747 /Ports | |
parent | e79a76690111c1fe9d3bf853f247256545529884 (diff) | |
download | serenity-66dcb0123ad9488eb8ecee20b6311e07fdf8c2c0.zip |
Ports: Explain some new patch script options and features in the README
This explains:
- `package.sh dev [--no-depends]`
- `use_fresh_config_sub` & `config_sub_path`
Diffstat (limited to 'Ports')
-rw-r--r-- | Ports/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/Ports/README.md b/Ports/README.md index 5ce147272f..f6715f087a 100644 --- a/Ports/README.md +++ b/Ports/README.md @@ -88,6 +88,24 @@ By default, [`clean`](#clean) and [`clean_dist`](#clean_dist) combined. Remove the port's files from the Serenity build directory, if it has a `plist` file. +#### `dev` + +Start a development session with guided patch importing. +This mode has a bunch of nice features: + +- Drops the user in a git repository backed by another (local) git repository + that acts as the "clean", patched version of the port that is ready to be built +- The "remote" repository can be pushed to, pulled from and generally anything that + you'd want to do with a remote repo. +- After leaving the dev shell, all patches are updated and the user will be prompted + whether they wish to generate a new patch readme file. + +This mode takes an extra `--no-depends` option, that if given, will cause the dependency +fetch and build steps to be skipped. + +This mode can also assist in migrating old patches to new versions through a guided +semi-automated process. + #### `--auto` Same as no option, but mark the port as having been installed automatically. @@ -151,6 +169,16 @@ Options passed to the port's [`configscript`](#configscript) in the default `--host=i686-pc-serenity` is always passed, override the `configure` function if that's undesirable. +#### `use_fresh_config_sub` + +Boolean option (`false` by default), will replace the `config.sub` pointed to by +`config_sub_path` as part of the patching process if set to true. + +#### `config_sub_path` + +Path to the `config.sub` file used by autoconf, starting at `$workdir`. +This is set to `config.sub` by default. + #### `configscript` Name of the script that will be run in the default `configure` function when |