doctools::changelog(n)

💖 doctools::changelog(n) — bestie edition 💖

okay so this is the manual page for doctools::changelog, living under Documentation tools, and it's literally about processing text in the Emacs ChangeLog format. yes the one emacs makes. no cap. 🦋

---

✨ NAME ✨

doctools::changelog — Processing text in Emacs ChangeLog format 🎀

---

🌸 SYNOPSIS 🌸

package require Tcl 8.5 9

package require textutil

package require doctools::changelog ?1.2?

::doctools::changelog::scan text

::doctools::changelog::flatten entries

::doctools::changelog::toDoctools title module version entries

::doctools::changelog::merge entries...

---

💅 DESCRIPTION 💅

So basically this package hands you a bunch of Tcl commands for processing and reformatting text that's written in the "ChangeLog" format — you know, the one emacs generates. it's giving parser-girlie energy and honestly? iconic. 🔥

---

🧚 API 🧚

::doctools::changelog::scan text

This one takes the text and parses it, assuming it contains a ChangeLog as generated by emacs. it hands back a data structure describing what's inside that ChangeLog. 🍓

The way this data structure works: it's a list, and every element in it describes one entry in the ChangeLog. Each element/entry is itself a list of three elements, describing the date of the entry, its author, and the comments made — in that exact order. And the last item in each element/entry, the comments? that's a list of sections. Every section is described by a list containing two elements: a list of file names, and a string with the true comment associated with the files of the section. 👑

{
    {
        date
        author
        {
            {
                {file ...}
                commenttext
            }
            ...
        }
    }
    {...}
}

::doctools::changelog::flatten entries

This command takes a list of entries like the ones change::scan (above) generates, and converts them into a simpler list of plain text blocks — each block containing all the information of a single entry. lowkey a glow-up for your data. ✨

::doctools::changelog::toDoctools title module version entries

This command converts the pre-parsed ChangeLog entries (as generated by the command ::doctools::changelog::scan) into a document in doctools format, and returns it as the result of the command. 💖

The other three arguments — title, module, version — supply the info for the header of that document, which isn't available from the changelog itself. so you gotta bring it yourself, bestie. 🫶

::doctools::changelog::merge entries...

Every argument of this command is assumed to be a pre-parsed Changelog as generated by the command ::doctools::changelog::scan. This command merges all of them into a single structure, and collapses multiple entries for the same date and author into a single entry. The new structure is returned as the result of the command. it's giving group project, but the good kind. 🌈

---

😭 BUGS, IDEAS, FEEDBACK 😭

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category doctools of the Tcllib Trackers at [http://core.tcl.tk/tcllib/reportlist]. Please also report any ideas for enhancements you may have for either package and/or documentation. we want the feedback fr fr. 💜

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar. 🎀

---

⭐ KEYWORDS ⭐

changelog, doctools, emacs

---

👑 CATEGORY 👑

Documentation tools

---

💀 COPYRIGHT 💀

Copyright (c) 2003-2013 Andreas Kupries <andreas_kupries@users.sourceforge.net>

---

and that's the whole page, bestie!! 🦋 this was tcllib version 1.2, and yeah the footer said doctools::changelog(n) — that's the page you just read, periodt. 💅✨