Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/packaging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ Please check the following:

- Search [open package requests](https://github.com/getsolus/packages/issues?q=sort%3Aupdated-desc+is%3Aopen+label%3A%22Package%3A+Addition+Request%22) to see if there is one for the package. If there isn't an existing issue, go ahead and submit your pull request. If there is already a pull request, please check its status to avoid duplicating work.
- If you are submitting a pull request for the inclusion of software in the repo, the package has a corresponding package request that is **accepted for inclusion** or is a dependency of a package that has been accepted into the repository.
- If you are updating a package, check to see if there's a maintainer. See [Updating an Existing Package].(docs/packaging/updating-an-existing-package.md).
- If this is your first package update with your environment, see [Your First Package Update](docs/packaging/your-first-package-update.md) to test your build environment.

## Building packages

Expand Down
4 changes: 4 additions & 0 deletions docs/packaging/packaging-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ If this happens, simply override with `patterns` or set `libsplit` to “no”.

**A note on static archives**: Unless it is absolutely unavoidable, you should disable static libraries within your build. This is usually fixed by adding `--disable-static` to your configure routine. If `*.a` files are shown in your packaging request, it will be questioned, as they can pose a greater security risk if packages link against these static archives.

#### Development modules should be normal packages without a -devel subpackage

In the cases where modules like `perl` or `python` would be split by the default `ypkg` policy (for instance because they contain category 3 `man` pages), the current best practice is to add a `patterns : /*` stanza to keep everything in the main package for convenience.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the cases where modules like `perl` or `python` would be split by the default `ypkg` policy (for instance because they contain category 3 `man` pages), the current best practice is to add a `patterns : /*` stanza to keep everything in the main package for convenience.
In the cases where modules like `perl` or `python` would be split by the default `ypkg` policy (for instance because they contain category 3 `man` pages), the best practice is to add a `patterns : /*` stanza to keep everything in the main package for convenience.

In the interest of keeping the documentation "timeless," I think we should avoid saying that "this is the way it currently is." I think it can be inferred that by virtue of being in the documentation, it is "current."


### The docs subpackage

Currently there is only one pattern which is forced into a `docs` subpackage:
Expand Down
2 changes: 1 addition & 1 deletion docs/packaging/procedures/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Procedures",
"label": "Procedures & Policies",
"link": {
"type": "generated-index"
}
Expand Down
Loading