commitid.scad.pl: Clearer docs

[reprap-play.git] / commitid.scad.pl

diff --git a/commitid.scad.pl b/commitid.scad.pl
index 5a61f415fdc353002336ed71a73645bf7bc8c88a..ebdbe917a39a6cb73db24da322d83a22e85af045 100755 (executable)
--- a/commitid.scad.pl
+++ b/commitid.scad.pl
@@ -52,6 +52,12 @@ $SIG{__WARN__} = sub { die @_; };
 #
 # We can generate these forms:
 #
+#  In each case:
+#    if tree is dirty, * is suffixed or prefixed to count or commitid
+#    if tree has untracked files, + is added
+#    (where it is added depends on the Form; in any case it does not
+#    change the size, but steals space from digits)
+#
 #   Small3:
 #   Small4:
 #   Small5:
@@ -63,28 +69,27 @@ $SIG{__WARN__} = sub { die @_; };
 #       git rev-list --first-parent --count HEAD
 #       typically 3-4 characters but we allow for up to 6
 #       padded with zeroes; if too long we reduce mod 10^n
-#       eg
-#            Small4    1070
-#       If tree is dirty, + or * is suffixed, reducing number of
-#       digits by 1.
+#       eg if the count is 123456
+#            Small5    3456*
+#            Small8    __123456    (where _ are spaces)
 #
 #   Small4S:
-#   Small6S:
-#   Small8S:
+#   Small6S:   Small6T:
+#   Small8S:   Small9T:
 #   Small10S:
-#       same but split into two lines eg
-#            Small4S  10
-#                     70
+#       same but split into two lines (S) or three lines (T) eg
+#            Small4S  45     Small6T   _3
+#                     6*               45
+#                                      6*
 #
 #   Git4   Git4S
-#   Git6   Git6S
+#   Git6   Git6S   Git6T
 #   Git8   Git8S
+#   Git9           Git9T
 #   Git10  Git10S
 #       git-rev-parse HEAD   (prefix of requested length)
-#       eg
-#            Git6    82f2a2
-#       If tree is dirty, + or * is suffixed to commitid,
-#       reducing number of hex digits by 1.
+#       eg if the commitid is abcdef0123...
+#            Git5    abcd*
 
 #   Full3
 #   Full4
@@ -97,10 +102,18 @@ $SIG{__WARN__} = sub { die @_; };
 #       git-rev-list --first-parent --count HEAD
 #       git-rev-parse HEAD
 #       eg
-#            Full6      1070
-#                     82f2a2
-#       If tree is dirty, + or * is suffixed to count (but not to
-#       commitid) reducing number of digits by 1.
+#            Full6    abcdef       Full8     abcdef01
+#                     23456*                 _123456*
+#
+#   Full6T
+#   Full9T
+#   Full12T
+#   Full15T
+#       as Full but commit is split over two lines
+#       for a 3-line message; eg
+#             Full9T    abc
+#                       de*
+#                       456
 #
 #   FontDemo
 #
@@ -269,15 +282,22 @@ sub ljustt ($$$) { # always includes $suffix
     return sprintf "%-${sz}.${sz}s%s", $whole, $suffix;
 }
 
+sub gentextmodule_q ($$$) {
+    my ($form, $s, $lines) = @_;
+    $gtm_demo_j++;
+    my $l = length $s;
+    return if $l % $lines;
+    my $e = $l/$lines;
+    return if $e < 2;
+    $gtm_demo_j--;
+    gentextmodule($form, $s =~ m/.{$e}/g);
+}
+
 sub gentextmodule_plusq ($$) {
     my ($form, $s) = @_;
-    my $l = length $s;
     gentextmodule($form, $s);
-    if (!($l & 1) && $l>=4) {
-       gentextmodule("${form}S", substr($s,0,$l/2), substr($s,$l/2));
-    } else {
-       $gtm_demo_j++;
-    }
+    gentextmodule_q("${form}S", $s, 2);
+    gentextmodule_q("${form}T", $s, 3);
 }
 
 our @gcmd;
@@ -342,10 +362,19 @@ sub do_git () {
        gentextmodule_plusq("Git$sz", ljustt($sz, $git_object, $git_dirty))
            if defined $git_object;
 
-       gentextmodule("Full$sz",
-                     rjustt($sz, $git_count.$git_dirty),
-                     ljustt($sz, $git_object, ''))
-           if defined $git_count && defined $git_object;
+       if (defined $git_count && defined $git_object) {
+           gentextmodule("Full$sz",
+                         ljustt($sz, $git_object, ''),
+                         rjustt($sz, $git_count.$git_dirty));
+
+           if (!($sz % 2)) {
+               my $e = $sz/2;
+               gentextmodule("Full".($e*3)."T",
+                             ljustt($e*2, $git_object, $git_dirty)
+                             =~ m/.{$e}/g,
+                             rjustt($e, $git_count));
+           }
+       }
     }
 }