From 81bcc70bcd88719006f90f71634d40c03c31a3ff Mon Sep 17 00:00:00 2001 From: Toyam Cox Date: Sun, 30 Apr 2017 12:51:50 -0400 Subject: [PATCH] Manual.md: mention the comments at template start --- Manual.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/Manual.md b/Manual.md index 97d6a06b44a..066cdd453ef 100644 --- a/Manual.md +++ b/Manual.md @@ -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) 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: ``` # Template file for 'foo' -pkgname="foo" -version="1.0" +pkgname=foo +version=1.0 revision=1 build_style=gnu-configure short_desc="A short description max 72 chars"