Meta/cook: leave a NEEDSWORK comment

gitster · gitster · commit 0e2d29bc9cb6 · 2017-10-30T15:07:38.000+09:00
A new topic that is still not ready for 'pu' which uses a topic in
flight appear in the description of the latter as "used by", even
though it does not appear in the report anywhere else.  Leave a note
to the place where this bug happens, as I do not have time to fix it
right now.
diff --git a/cook b/cook
@@ -250,6 +250,15 @@ sub get_commit {
 		}
 
 		my $list = join("\n", map { " " . $_ } @desc);
+
+		# NEEDSWORK:
+		# This is done a bit too early. We grabbed all
+		# under refs/heads/??/* without caring if they are
+		# merged to 'pu' yet, and it is correct because
+		# we want to describe a topic that is in the old
+		# edition that is tentatively kicked out of 'pu'.
+		# However, we do not want to say a topic is used
+		# by a new topic that is not yet in 'pu'!
 		my $relation = describe_relation($topic{$branch});
 		$topic{$branch}{'desc'} = $head . $list;
 		if ($relation) {
