Re: [PATCH 2/8] xdl_change_compact(): clarify code

From: Stefan Beller <sbeller@google.com>
Date: Aug 3, 2016, 22:11 UTC
Message-ID: <CAGZ79kZk+XW+Bwcx_fvOLVBDse_iUSjEa_K=eJqm4PpTsTAcPA@mail.gmail.com>
In-Reply-To: <f4ce27f389b64c9ae503152c66d183c4a4a970f1.1470259583.git.mhagger@alum.mit.edu>

On Wed, Aug 3, 2016 at 3:00 PM, Michael Haggerty <mhagger@alum.mit.edu> wrote:

> Write things out a bit longer but less cryptically. Add more comments.

By less cryptic you mean in Git coding style ;) The original author (do we want to cc Davido?) may disagree.

Show 5 quoted lines

> +
> +                       /*
> +                        * Are there any blank lines that could appear as the last
> +                        * line of this group?
> +                        */

IIRC this comment is not quite correct as this 'only' counts the number of blank lines within the forward shifting section, i.e. in the movable space.

Later we use it as a boolean indicator (whether or not it is equal to 0) to see if we can do better.

Any other change in code and comments looks good to me, but this stood out like a sore thumb. (Probably the old heuristic as a whole stood out, but the comment here specifically sounds /wrong/ to me in this place. How can a question document a variable? I'd rather expect a question comment to ease the understanding of a condition)

Thanks for reviving this topic! Stefan