Manual.md: mention the comments at template start
This commit is contained in:
parent
f183bd385e
commit
81bcc70bcd
1 changed files with 6 additions and 2 deletions
|
@ -53,13 +53,17 @@ The `template files` are `GNU bash` shell scripts that must define some required
|
||||||
`variables` and `functions` that are processed by `xbps-src` (the package builder)
|
`variables` and `functions` that are processed by `xbps-src` (the package builder)
|
||||||
to generate the resulting binary packages.
|
to generate the resulting binary packages.
|
||||||
|
|
||||||
|
By convention, all templates start with a comment briefly explaining what they
|
||||||
|
are. In addition, pkgname and version can't have any characters in them that
|
||||||
|
would require them to be quoted, so they are not quoted.
|
||||||
|
|
||||||
A simple `template` example is as follows:
|
A simple `template` example is as follows:
|
||||||
|
|
||||||
```
|
```
|
||||||
# Template file for 'foo'
|
# Template file for 'foo'
|
||||||
|
|
||||||
pkgname="foo"
|
pkgname=foo
|
||||||
version="1.0"
|
version=1.0
|
||||||
revision=1
|
revision=1
|
||||||
build_style=gnu-configure
|
build_style=gnu-configure
|
||||||
short_desc="A short description max 72 chars"
|
short_desc="A short description max 72 chars"
|
||||||
|
|
Loading…
Reference in a new issue