git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Simon Courtois <scourtois@cubyx.fr>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v2 1/7] color: fix max-size comment
Date: Thu, 23 Jun 2016 13:31:44 -0400	[thread overview]
Message-ID: <20160623173144.GA15774@sigill.intra.peff.net> (raw)
In-Reply-To: <20160623173048.GA19923@sigill.intra.peff.net>

We use fixed-size buffers for colors, because we know our
parsing cannot grow beyond a particular bound. However, our
comment description has two issues:

  1. It has the description in two forms: a short one, and
     one with more explanation. Over time the latter has
     been updated, but the former has not. Let's just drop
     the short one (after making sure everything it says
     is in the long one).

  2. As of ff40d18 (parse_color: recognize "no$foo" to clear
     the $foo attribute, 2014-11-20), the per-attribute size
     bumped to "3" (because "nobold" is actually "21;"). But
     that's not quite enough, as somebody may use both
     "bold" and "nobold", requiring 5 characters.

     This wasn't a problem for the final count, because we
     over-estimated in other ways, but let's clarify how we
     got to the final number.

Signed-off-by: Jeff King <peff@peff.net>
---
Unchanged from v1.

 color.h | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

diff --git a/color.h b/color.h
index e155d13..e24fa0b 100644
--- a/color.h
+++ b/color.h
@@ -3,18 +3,20 @@
 
 struct strbuf;
 
-/*  2 + (2 * num_attrs) + 8 + 1 + 8 + 'm' + NUL */
-/* "\033[1;2;4;5;7;38;5;2xx;48;5;2xxm\0" */
 /*
  * The maximum length of ANSI color sequence we would generate:
  * - leading ESC '['            2
- * - attr + ';'                 3 * 10 (e.g. "1;")
+ * - attr + ';'                 2 * num_attr (e.g. "1;")
+ * - no-attr + ';'              3 * num_attr (e.g. "22;")
  * - fg color + ';'             17 (e.g. "38;2;255;255;255;")
  * - bg color + ';'             17 (e.g. "48;2;255;255;255;")
  * - terminating 'm' NUL        2
  *
- * The above overcounts attr (we only use 5 not 8) and one semicolon
- * but it is close enough.
+ * The above overcounts by one semicolon but it is close enough.
+ *
+ * The space for attributes is also slightly overallocated, as
+ * the negation for some attributes is the same (e.g., nobold and nodim).
+ * We also allocate space for 6 attributes (even though we have only 5).
  */
 #define COLOR_MAXLEN 70
 
-- 
2.9.0.209.g845fbc1


  reply	other threads:[~2016-06-23 17:31 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-06-23 11:54 Italics formatting Simon Courtois
2016-06-23 13:08 ` [PATCH 0/2] more ANSI attributes Jeff King
2016-06-23 13:09   ` [PATCH 1/2] color: fix max-size comment Jeff King
2016-06-23 13:10   ` [PATCH 2/2] color: support "italic" attribute Jeff King
2016-06-23 13:57     ` Simon Courtois
2016-06-23 16:46     ` Junio C Hamano
2016-06-23 16:47       ` Jeff King
2016-06-23 17:30   ` [PATCH v2 0/7] more ANSI attributes Jeff King
2016-06-23 17:31     ` Jeff King [this message]
2016-06-23 17:32     ` [PATCH v2 2/7] doc: refactor description of color format Jeff King
2016-06-23 17:33     ` [PATCH v2 3/7] add skip_prefix_mem helper Jeff King
2016-06-23 17:38     ` [PATCH v2 4/7] color: refactor parse_attr Jeff King
2016-06-23 17:38     ` [PATCH v2 5/7] color: allow "no-" for negating attributes Jeff King
2016-06-23 17:39     ` [PATCH v2 6/7] color: support "italic" attribute Jeff King
2016-06-23 18:34       ` Junio C Hamano
2016-06-23 18:36         ` Jeff King
2016-06-23 17:40     ` [PATCH v2 7/7] color: support strike-through attribute Jeff King
2016-06-23 18:36       ` Junio C Hamano
2016-06-23 18:39         ` Jeff King
2016-06-23 18:52           ` Junio C Hamano
2016-06-23 19:03             ` Junio C Hamano
2016-06-23 19:04             ` Jeff King
2016-06-23 19:11               ` Junio C Hamano
2016-06-23 19:56           ` Junio C Hamano

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20160623173144.GA15774@sigill.intra.peff.net \
    --to=peff@peff.net \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    --cc=scourtois@cubyx.fr \
    /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.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).