From d513d8b6aa8c70191deb3e1a8392819c9181a8f9 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Tue, 7 Jan 2020 20:42:53 +0000 Subject: [PATCH] docs: Add empty Goalfile(5) and goals-reference(5). --- Goalfile.in | 4 +++- docs/Goalfile.pod | 42 ++++++++++++++++++++++++++++++++++++++++++ docs/goals-reference.pod | 40 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 85 insertions(+), 1 deletion(-) create mode 100644 docs/Goalfile.pod create mode 100644 docs/goals-reference.pod diff --git a/Goalfile.in b/Goalfile.in index 75ce273..b865c9c 100644 --- a/Goalfile.in +++ b/Goalfile.in @@ -110,7 +110,9 @@ goal depend = let POD2MAN = "@POD2MAN@" -goal documentation = : pod2man ("goals", "1") +goal documentation = : pod2man ("goals", "1"), + pod2man ("Goalfile", "5"), + pod2man ("goals-reference", "5") goal pod2man (page, section) = "man/%page.%section" : "docs/%page.pod" { diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod new file mode 100644 index 0000000..18142fe --- /dev/null +++ b/docs/Goalfile.pod @@ -0,0 +1,42 @@ +=encoding utf8 + +=head1 NAME + +Goalfile - introduction and tutorial to writing goal files + +=head1 SUMMARY + + +=head1 DESCRIPTION + + + + + +=head1 SEE ALSO + +L, L. + +=head1 AUTHORS + +Richard W.M. Jones + +=head1 COPYRIGHT + +Copyright (C) 2020 Richard W.M. Jones + +Copyright (C) 2020 Red Hat Inc. + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. diff --git a/docs/goals-reference.pod b/docs/goals-reference.pod new file mode 100644 index 0000000..5cda4f5 --- /dev/null +++ b/docs/goals-reference.pod @@ -0,0 +1,40 @@ +=encoding utf8 + +=head1 NAME + +goals-reference - reference manual for goals and writing goal files + +=head1 SUMMARY + + +=head1 DESCRIPTION + + + +=head1 SEE ALSO + +L, L. + +=head1 AUTHORS + +Richard W.M. Jones + +=head1 COPYRIGHT + +Copyright (C) 2020 Richard W.M. Jones + +Copyright (C) 2020 Red Hat Inc. + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License along +with this program; if not, write to the Free Software Foundation, Inc., +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. -- 1.8.3.1