discuss@mandoc.bsd.lv
 help / color / mirror / Atom feed
* Spurious space in demandoc.1
@ 2022-03-13  1:20 Paul A. Patience
  2022-03-20 16:00 ` Ingo Schwarze
  0 siblings, 1 reply; 3+ messages in thread
From: Paul A. Patience @ 2022-03-13  1:20 UTC (permalink / raw)
  To: discuss


Hi,

I found a typo in demandoc.1.
Not sure if it's worth a commit all by itself.

Best regards,
Paul

--- demandoc.1.bak	2022-03-12 20:11:41.670983926 -0500
+++ demandoc.1	2022-03-12 20:11:45.715031175 -0500
@@ -80,7 +80,7 @@
 Such errors cause
 .Nm
 to exit at once, possibly in the middle of parsing or formatting a file.
-The output databases are corrupt and should be removed .
+The output databases are corrupt and should be removed.
 .El
 .Sh EXAMPLES
 The traditional usage of

--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Spurious space in demandoc.1
  2022-03-13  1:20 Spurious space in demandoc.1 Paul A. Patience
@ 2022-03-20 16:00 ` Ingo Schwarze
  2022-03-20 16:05   ` Ingo Schwarze
  0 siblings, 1 reply; 3+ messages in thread
From: Ingo Schwarze @ 2022-03-20 16:00 UTC (permalink / raw)
  To: paul, discuss

Hi Paul,

Paul A. Patience wrote on Sun, Mar 13, 2022 at 01:20:37AM +0000:

> I found a typo in demandoc.1.
> Not sure if it's worth a commit all by itself.

Yes it would, even small bugs are worth fixing, and there is no
benefit to letting bugfix patches accumulate before committing.

However, the whole sentence is misplaced, meaningless, and confusing
in this manual page, so i just deleted the whole line outright,
see the committed patch below.

While here, please note that the whole demandoc(1) program is kind
of an anachronism.  You are usually better off using "mandoc FILE |
col -b" instead because demandoc(1) soemtimes deletes too much
from the output stream.

Multiple times, i felt tempted to delete the whole demandoc(1)
program from the mandoc toolbox without any replacement.
The only reason i didn't delete it yet is that i'm not completely
sure what people use it for, how they use it, and why.
Myself, i certainly do not use it and hardly bother maintaining
it unless compilation breaks.  Then again, i absolutely never use
spell checking programs, and when they are built in to other
software, i completely disable all spell checking features
wherever i can.

*If* demandoc(1) has any merit in the context of spell checking
(or in any other area) then rather than deleting it outright,
it would be better to clean up and improve the required features
and include them in the mandoc(1) program itself.  So demandoc(1)
will probably lurk around half-unmaintained until i understand
its uses and find a tester who will explain those uses and later
test patches to mandoc to support them natively instead of in a
rather dirty additional program.

Yours,
  Ingo


Index: demandoc.1
===================================================================
RCS file: /home/cvs/mandoc/mandoc/demandoc.1,v
retrieving revision 1.8
diff -u -r1.8 demandoc.1
--- demandoc.1	12 Sep 2014 00:10:26 -0000	1.8
+++ demandoc.1	20 Mar 2022 15:36:09 -0000
@@ -80,7 +80,6 @@
 Such errors cause
 .Nm
 to exit at once, possibly in the middle of parsing or formatting a file.
-The output databases are corrupt and should be removed .
 .El
 .Sh EXAMPLES
 The traditional usage of
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Spurious space in demandoc.1
  2022-03-20 16:00 ` Ingo Schwarze
@ 2022-03-20 16:05   ` Ingo Schwarze
  0 siblings, 0 replies; 3+ messages in thread
From: Ingo Schwarze @ 2022-03-20 16:05 UTC (permalink / raw)
  To: paul; +Cc: discuss

Ingo Schwarze wrote on Sun, Mar 20, 2022 at 05:00:31PM +0100:

> However, the whole sentence is misplaced, meaningless, and confusing
> in this manual page, so i just deleted the whole line outright,
> see the committed patch below.

Oops, sorry, i accidentally omitted the commit message in
this mailing list post, so here it is.


Log Message:
-----------
The demandoc(1) program neither reads nor writes any databases, so
delete a sentence taking about databases.  Having that sentence in
the first place probably was a copy-and-paste mistake when adopting
some text from the makewhatis(8) manual page.

Triggered by a smaller patch sent to discuss@
by Paul A. Patience <paul at apatience dot com>.


> Index: demandoc.1
> ===================================================================
> RCS file: /home/cvs/mandoc/mandoc/demandoc.1,v
> retrieving revision 1.8
> diff -u -r1.8 demandoc.1
> --- demandoc.1	12 Sep 2014 00:10:26 -0000	1.8
> +++ demandoc.1	20 Mar 2022 15:36:09 -0000
> @@ -80,7 +80,6 @@
>  Such errors cause
>  .Nm
>  to exit at once, possibly in the middle of parsing or formatting a file.
> -The output databases are corrupt and should be removed .
>  .El
>  .Sh EXAMPLES
>  The traditional usage of
--
 To unsubscribe send an email to discuss+unsubscribe@mandoc.bsd.lv


^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-03-20 16:05 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-13  1:20 Spurious space in demandoc.1 Paul A. Patience
2022-03-20 16:00 ` Ingo Schwarze
2022-03-20 16:05   ` Ingo Schwarze

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).