From: Ingo Schwarze <schwarze@usta.de>
To: Dag-Erling Smoergrav <des@des.no>
Cc: discuss@mdocml.bsd.lv
Subject: Re: Mdocdate
Date: Fri, 13 Nov 2015 00:06:19 +0100 [thread overview]
Message-ID: <20151112230619.GN20023@athene.usta.de> (raw)
In-Reply-To: <20151112213135.GL20023@athene.usta.de>
Hi Dag-Erling,
Ingo Schwarze wrote on Thu, Nov 12, 2015 at 10:31:35PM +0100:
> Dag-Erling Smoergrav wrote on Thu, Nov 12, 2015 at 10:25:42AM +0100:
>> - in time2a():
>>
>> Use a sufficiently large stack buffer and mandoc_strdup() instead of
>> trying to guess at the correct length.
> This does look useful, it simplifies the code.
Unfortunately, testing revealed that it breaks the output.
I have added a comment explaining why the seemingly weird
formatting code is required, such that people don't write
the same patch again.
However, i did simplify the code in mandoc_normdate()
the way you suggested and added some comments there, too.
It is much more readable now, thanks for the idea.
Yours,
Ingo
Log Message:
-----------
Simplify the logic in mandoc_normdate() and add some comments.
Also add a comment in time2a() explaining why it isn't possible
to use just one single call to strftime().
Do some style cleanup while here.
No functional change.
Triggered by a very different patch from des@FreeBSD.
Modified Files:
--------------
mdocml:
mandoc.c
Revision Data
-------------
Index: mandoc.c
===================================================================
RCS file: /home/cvs/mdocml/mdocml/mandoc.c,v
retrieving revision 1.97
retrieving revision 1.98
diff -Lmandoc.c -Lmandoc.c -u -p -r1.97 -r1.98
--- mandoc.c
+++ mandoc.c
@@ -478,17 +478,27 @@ time2a(time_t t)
* up to 2 characters for the day + comma + blank
* 4 characters for the year and a terminating '\0'
*/
+
p = buf = mandoc_malloc(10 + 4 + 4 + 1);
- if (0 == (ssz = strftime(p, 10 + 1, "%B ", tm)))
+ if ((ssz = strftime(p, 10 + 1, "%B ", tm)) == 0)
goto fail;
p += (int)ssz;
- if (-1 == (isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)))
+ /*
+ * The output format is just "%d" here, not "%2d" or "%02d".
+ * That's also the reason why we can't just format the
+ * date as a whole with "%B %e, %Y" or "%B %d, %Y".
+ * Besides, the present approach is less prone to buffer
+ * overflows, in case anybody should ever introduce the bug
+ * of looking at LC_TIME.
+ */
+
+ if ((isz = snprintf(p, 4 + 1, "%d, ", tm->tm_mday)) == -1)
goto fail;
p += isz;
- if (0 == strftime(p, 4 + 1, "%Y", tm))
+ if (strftime(p, 4 + 1, "%Y", tm) == 0)
goto fail;
return buf;
@@ -500,23 +510,29 @@ fail:
char *
mandoc_normdate(struct mparse *parse, char *in, int ln, int pos)
{
- char *out;
time_t t;
- if (NULL == in || '\0' == *in ||
- 0 == strcmp(in, "$" "Mdocdate$")) {
+ /* No date specified: use today's date. */
+
+ if (in == NULL || *in == '\0' || strcmp(in, "$" "Mdocdate$") == 0) {
mandoc_msg(MANDOCERR_DATE_MISSING, parse, ln, pos, NULL);
- time(&t);
+ return time2a(time(NULL));
}
- else if (a2time(&t, "%Y-%m-%d", in))
- t = 0;
- else if (!a2time(&t, "$" "Mdocdate: %b %d %Y $", in) &&
- !a2time(&t, "%b %d, %Y", in)) {
+
+ /* Valid mdoc(7) date format. */
+
+ if (a2time(&t, "$" "Mdocdate: %b %d %Y $", in) ||
+ a2time(&t, "%b %d, %Y", in))
+ return time2a(t);
+
+ /* Do not warn about the legacy man(7) format. */
+
+ if ( ! a2time(&t, "%Y-%m-%d", in))
mandoc_msg(MANDOCERR_DATE_BAD, parse, ln, pos, in);
- t = 0;
- }
- out = t ? time2a(t) : NULL;
- return out ? out : mandoc_strdup(in);
+
+ /* Use any non-mdoc(7) date verbatim. */
+
+ return mandoc_strdup(in);
}
int
--
To unsubscribe send an email to discuss+unsubscribe@mdocml.bsd.lv
next prev parent reply other threads:[~2015-11-12 23:06 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-11-12 9:25 Mdocdate Dag-Erling Smørgrav
2015-11-12 21:31 ` Mdocdate Ingo Schwarze
2015-11-12 23:06 ` Ingo Schwarze [this message]
2015-11-13 5:52 ` Mdocdate Dag-Erling Smørgrav
2015-11-14 1:22 ` Mdocdate Ingo Schwarze
2015-11-14 15:02 ` Mdocdate Steffen Nurpmeso
2015-11-15 1:51 ` Mdocdate Ingo Schwarze
2015-11-16 13:35 ` Mdocdate Steffen Nurpmeso
2015-11-17 9:12 ` Mdocdate Svyatoslav Mishyn
2015-11-17 10:35 ` Mdocdate Steffen Nurpmeso
2015-11-23 20:48 ` Mdocdate Michael Dexter
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20151112230619.GN20023@athene.usta.de \
--to=schwarze@usta.de \
--cc=des@des.no \
--cc=discuss@mdocml.bsd.lv \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).