From f4c716f0b0b1f3eaa29d7a9de58f5b7e873d089f Mon Sep 17 00:00:00 2001 From: Mattias Andrée Date: Sun, 22 Feb 2026 13:44:56 +0100 Subject: fix doc text MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Mattias Andrée --- README | 48 ++++++++++++++++++++++++------------------------ makeenv.1 | 35 +++++++++++++++++------------------ makeenv.5 | 10 +++++----- makeenv.c | 2 +- 4 files changed, 47 insertions(+), 48 deletions(-) diff --git a/README b/README index 1edf93c..c74a79f 100644 --- a/README +++ b/README @@ -1,7 +1,7 @@ NAME makeenv - Run make(1) with environment loaded from .makeenv -SYNPOSIS +SYNOPSIS makeenv [arguments] ... DESCRIPTION @@ -11,44 +11,44 @@ DESCRIPTION executes make(1). Any macro listed in .makeenv is also put in the environment. - After loading .makeenv and adding populating the environment, - makeenv will inspect it's environment, makeenv itself is - affected by the environment variables, which also are make(1) - macros; this if you need a specific implementation of make(1) + After loading .makeenv and populating the environment, + makeenv will inspect its environment. makeenv itself is + affected by the environment variables, which are also make(1) + macros; thus, if you need a specific implementation of make(1) for a project, it can be specified in the .makeenv file. - When executng make(1), makeenv may reorder the arguments, and + When executing make(1), makeenv may reorder the arguments, and will put any option listed in .makeenv at the beginning, any macro listed in .makeenv before the macros in the arguments, and any target listed in .makeenv before the targets in the arguments. makeenv is designed to be usable in place of make(1), that is, - the user can create add the alias makeenv=make in his shell, - without any adverse affect. makeenv will pass on it's arguments + the user can create the alias makeenv=make in his shell, + without any adverse effect. makeenv will pass on its arguments as is to make(1) (or whichever utility is specified in the environment variable MAKEENV_MAKE or the environment variable MAKE) without validation or modifications, if the .makeenv does not exist. OPTIONS - The makeenv utility passes it's options to the make(1) utility - and do not act on any of the it self, however in order to + The makeenv utility passes its options to the make(1) utility + and does not act on any of them itself; however, in order to properly interleave options and operands specified in the - .makeenv file, it have to understand which options take an + .makeenv file, it has to understand which options take an argument and which do not. By default, the makeenv utility only - understands the options specified by POSIX, and the argumented - option -W (vendor options), as well as long options that start - with two dashes (--) provided that the same command line - argument contains an equals sign (=). The user can modify the - environment variables to modify how the makeenv utility - understands the options. See the section ENVIRONMENT VARIABLES - for more information. The current version only support options - that consist of a dash (-) followed by any other character and - options that start with two dashes (--), followed by at least - one character, but may not contain an equals sign (=), as these - are treated as delimiters between long options and their - associated argument. + understands the options specified by POSIX, and the option -W + (vendor options), which takes an argument, as well as long + options that start with two dashes (--) provided that the same + command line argument contains an equals sign (=). The user + can modify the environment variables to modify how the makeenv + utility understands the options. See the section ENVIRONMENT + VARIABLES for more information. The current version only + supports options that consist of a dash (-) followed by any + other character and options that start with two dashes (--), + followed by at least one character, but may not contain an + equals sign (=), as these are treated as delimiters between + long options and their associated argument. ENVIRONMENT VARIABLES The following environment variables affect the execution of @@ -120,7 +120,7 @@ ENVIRONMENT VARIABLES (Default is the empty string, meaning no options.) Any macro listed in .makeenv is loaded into the environment - before the utility inspects the environement. + before the utility inspects the environment. SEE ALSO makeenv(5), make(1) diff --git a/makeenv.1 b/makeenv.1 index 1e72d61..818c82e 100644 --- a/makeenv.1 +++ b/makeenv.1 @@ -1,7 +1,7 @@ .TH MAKEENV 1 MAKEENV .SH NAME makeenv - Run make(1) with environment loaded from .makeenv -.SH SYNPOSIS +.SH SYNOPSIS .B makeenv .RI [ arguments "] ..." .SH DESCRIPTION @@ -21,20 +21,20 @@ is also put in the environment. .PP After loading .I .makeenv -and adding populating the environment, +and populating the environment, .B makeenv -will inspect it's environment, +will inspect its environment. .B makeenv itself is affected by the environment variables, which also are .BR make (1) -macros; this if you need a specific implementation of +macros; thus, if you need a specific implementation of .BR make (1) for a project, it can be specified in the .I .makeenv file. .PP -When executng +When executing .BR make (1), .B makeenv may reorder the @@ -53,12 +53,12 @@ before the targets in the .B makeenv is designed to be usable in place of .BR make (1), -that is, the user can create add the +that is, the user can create the .B alias .I makeenv=make -in his shell, without any adverse affect. +in his shell, without any adverse effect. .B makeenv -will pass on it's arguments as is to +will pass on its arguments as is to .BR make (1) (or whichever utility is specified in the environment variable @@ -71,20 +71,20 @@ does not exist. .SH OPTIONS The .BR makeenv -utility passes it's options to the +utility passes its options to the .BR make (1) -utility and do not act on any of the it self, however +utility and does not act on any of them itself; however, in order to properly interleave options and operands specified in the .I .makeenv -file, it have to understand which options take an argument +file, it has to understand which options take an argument and which do not. By default, the .BR makeenv utility only understands the options specified by POSIX, -and the argumented option +and the option .B -W -(vendor options), as well as long options that start with -two dashes +(vendor options), which takes an argument, as well as long +options that start with two dashes .RB ( -- ) provided that the same command line argument contains an equals sign @@ -94,7 +94,7 @@ variables to modify how the .BR makeenv utility understands the options. See the section .B ENVIRONMENT VARIABLES -for more information. The current version only support +for more information. The current version only supports options that consist of a dash .RB ( - ) followed by any other character and options that start @@ -105,7 +105,6 @@ an equals sign .RB ( = ), as these are treated as delimiters between long options and their associated argument. -.BR .SH STDIN Not used. .SH INPUT FILES @@ -228,7 +227,7 @@ Space-separated list of long options that shall interpret as .BR make (1) options that have an argument if it is -the option string is is directly followed +the option string is directly followed by equals sign .RB ( = ) in the same command line argument or if @@ -243,7 +242,7 @@ empty string, meaning no options.) Any macro listed in .I .makeenv is loaded into the environment before the utility inspects -the environement. +the environment. .SH ASYNCHRONOUS EVENTS Default. .SH STDOUT diff --git a/makeenv.5 b/makeenv.5 index 1a35fe3..f62fe47 100644 --- a/makeenv.5 +++ b/makeenv.5 @@ -1,8 +1,8 @@ .TH MAKEENV 5 MAKEENV .SH NAME makeenv - Environment for make(1) via makeenv(1) -.SH SYNPOSIS -.RB .makeenv +.SH SYNOPSIS +.B .makeenv .SH DESCRIPTION The .B makeenv @@ -17,7 +17,7 @@ that should also be built. .PP The .B makeenv -file is intepreted line by line, discarding any line +file is interpreted line by line, discarding any line that is empty or otherwise blank or whose first non-blank character is the hash sign .RB ( # ). @@ -26,7 +26,7 @@ Lines starting with a dash .RB ( - ) as its first non-blank character are interpreted as options that shall be used, the line is split at each whitespace, -and the empty tokes are discarded and the remaining tokens +and empty tokens are discarded and the remaining tokens put in the command line. Note that it is impossible to have whitespace in an argument as it will split the argument into two arguments. @@ -38,7 +38,7 @@ and as targets otherwise. Target lines are separated by whitespace and each non-empty token is added into the command line as target. Line that are interpreted as macro lines have leading and trailing white space removed, and any -sequence of whitespace around it's first equals sign +sequence of whitespace around its first equals sign .RB ( = ) removed. .SH NOTES diff --git a/makeenv.c b/makeenv.c index 0c2bdda..2025861 100644 --- a/makeenv.c +++ b/makeenv.c @@ -121,7 +121,7 @@ put_option_prefix_dash(const char *s) /** * Add all options from a list to the list of options * - * @parm s The list of options to add; elements are separated by spaces + * @param s The list of options to add; elements are separated by spaces */ static void put_options(char *s) -- cgit v1.2.3-70-g09d2