From 70c689283bb2c1ba07704be7562767daf82b4d46 Mon Sep 17 00:00:00 2001 From: "Richard W.M. Jones" Date: Sun, 12 Jan 2020 19:15:42 +0000 Subject: [PATCH] docs: Remove separate goals-reference manual. Goalfile(5) will contain both a tutorial and reference. --- Goalfile.in | 3 +-- docs/Goalfile.pod | 11 +++++------ docs/goals-reference.pod | 40 ---------------------------------------- docs/goals.pod | 11 ++++------- 4 files changed, 10 insertions(+), 55 deletions(-) delete mode 100644 docs/goals-reference.pod diff --git a/Goalfile.in b/Goalfile.in index 38570aa..d28b931 100644 --- a/Goalfile.in +++ b/Goalfile.in @@ -126,8 +126,7 @@ goal depend = let POD2MAN = "@POD2MAN@" goal documentation = : pod2man ("goals", "1"), - pod2man ("Goalfile", "5"), - pod2man ("goals-reference", "5") + pod2man ("Goalfile", "5") goal pod2man (page, section) = "man/%page.%section" : "docs/%page.pod" { diff --git a/docs/Goalfile.pod b/docs/Goalfile.pod index 18142fe..da4b142 100644 --- a/docs/Goalfile.pod +++ b/docs/Goalfile.pod @@ -2,20 +2,19 @@ =head1 NAME -Goalfile - introduction and tutorial to writing goal files +Goalfile - introduction, tutorial, and reference for writing goal files =head1 SUMMARY +=head1 INTRODUCTION -=head1 DESCRIPTION - - - +=head1 TUTORIAL +=head1 REFERENCE =head1 SEE ALSO -L, L. +L. =head1 AUTHORS diff --git a/docs/goals-reference.pod b/docs/goals-reference.pod deleted file mode 100644 index 5cda4f5..0000000 --- a/docs/goals-reference.pod +++ /dev/null @@ -1,40 +0,0 @@ -=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. diff --git a/docs/goals.pod b/docs/goals.pod index f21ae21..cf67a45 100644 --- a/docs/goals.pod +++ b/docs/goals.pod @@ -26,10 +26,8 @@ problems that make suffers from. This manual page documents the command line tool and options. -There is an introduction and tutorial on writing goal files: -L. - -There is also a reference manual: L. +There is an introduction to and tutorial on writing goal files, as +well as a reference manual in L. =head1 OPTIONS @@ -70,8 +68,7 @@ if I<-C> was not used. Specify an include directory, used when including goal files using the C directive. You can use this option multiple times. Later directories have priority over earlier ones. There is also an -implicit C<%stdlib> directory which is used for prelude files (see -L). +implicit C<%stdlib> directory which is used for prelude files. Note that if a relative path is given here, it is relative to the directory specified with the I<-C> option, or to the current directory @@ -106,7 +103,7 @@ turning all S> sections into S> sections. =head1 SEE ALSO -L, L, L. +L, L. =head1 AUTHORS -- 1.8.3.1