fix: place tix rebase state after todo help

Codex committed 3 months ago

Commit 472d81e1 parent e66aa542 files · +14 −9Browse files

Unified · Split

2 files

gix-tix/spec.md +5 −4
gix-tix/src/edit/todo.rs +9 −5

   trailer in any source message. Name and email pairs are compared without
   mailmap. All folded IDs and mutable refs map to the one resulting commit;
   resources owned by a later folded review commit are removed.
-- The first line points to complete self-documenting help at the bottom. All
+- The first line points to complete self-documenting help after the editable
-  instructions are enclosed in Markdown comments so only headings and command
+  todo. All instructions are enclosed in Markdown comments so only headings and
-  lines participate in the editable plan.
+  command lines participate in the editable plan.
 - A versioned Markdown state comment makes the document independently
   applicable in a later process. It records full base, target, scope and tip IDs,
   checkout requirements, and compare-and-swap state for mutable refs. Ref names
   use Git-compatible C-style quoting so arbitrary ref bytes round-trip. Missing
-  state cancels; present invalid state never reaches repository mutation.
+  state cancels; present invalid state never reaches repository mutation. The
+  state comment follows the complete help at the end of the document.
 - Pick lines use display-only state symbols documented in the footer: `↻` for a
   lazy rebase, `◌` for an invalidated signature awaiting signing, `◐` for an
   unverified signature, and `○` for an unsigned commit. Applicable states may be

gix-tix/src/edit/todo.rs+9−5

         checkout_allowed: repo.workdir().is_some(),
         expected_refs,
     };
-    let mut document = b"<!-- Rebase help is at the bottom of this file. -->\n".to_vec();
+    let mut document = b"<!-- Rebase help follows the editable todo. -->\n".to_vec();
-    write_state(&mut document, &state);
-    document.push(b'\n');
     document.extend_from_slice(title.as_bytes());
     document.extend_from_slice(b"\n\n");
     let anchor_kind = if base == onto {
         write_fork_heading(&mut document, repo, onto, Some((anchor_kind, anchor_title.as_str())))?;
     }
     document.extend_from_slice(HELP.as_bytes());
+    write_state(&mut document, &state);
     Ok(Prepared {
         document,
         apply_unchanged,
         let prepared = prepare_test(&repo, base, base, &commits, Some(tip))?;
         assert!(!prepared.apply_unchanged);
         let document = String::from_utf8(prepared.document.clone())?;
-        assert!(document.starts_with("<!-- Rebase help is at the bottom of this file. -->"));
+        assert!(document.starts_with("<!-- Rebase help follows the editable todo. -->"));
         assert!(document.contains(STATE_START), "the todo carries its transaction state");
         assert!(document.contains(&format!("# Rebase from `{}`", base.to_hex_with_len(7))));
         assert!(document.contains(&format!("## fork {} (base) base", base.to_hex_with_len(7))));
             document.find("# Rebase todo help").expect("help is present") > tip,
             "complete instructions follow the editable todo"
         );
-        assert!(document.ends_with("-->\n"), "all trailing help is one Markdown comment");
+        assert!(
+            document.find(STATE_START).expect("state is present")
+                > document.find("# Rebase todo help").expect("help is present"),
+            "transaction state follows the complete help"
+        );
+        assert!(document.ends_with("-->\n"), "the trailing state is a Markdown comment");
         assert!(
             document.contains("○"),
             "unsigned commits carry the documented status symbol"

fix: place tix rebase state after todo help

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code