about summary refs log tree commit homepage
path: root/HACKING
DateCommit message (Collapse)
2023-08-28Fix some typos/grammar/errors in docs and comments
2023-07-13doc: HACKING: drop bit about Debian 9.x (stretch)
It's oldoldstable, by now; just refer to Debian stable as the primary but keep LTS distros in mind because stuff like CentOS 7.x needs to remain supported.
2021-05-04treewide: update to v3 Tor onions
v2 onions are insecure, deprecated and going away. v3 names are unfortunately longer and more difficult to remember, but should be more resistant to attack than v2 ones.
2021-02-04doc: update dependencies (+Storable, Data::Dumper)
The new IPC stuff doesn't work without Storable or Sereal. Storable is part of the standard library since Perl 5.8, so we'll put a hard dependency on it for distros that package it separately. Data::Dumper is also part of the standard library, and PublicInbox::MboxReader uses it, and it's frequently useful during development. We'll also trim down INSTALL for standard library modules so it's hopefully less daunting for new users. Development dependencies are noted in HACKING, now. Email::MIME is only used for maintainer tests, so it's only documented in HACKING.
2021-02-04HACKING: use "just-ahead-of-time" to describe Inline::C
Inline::C works during module load time, so "just-ahead-of-time" is a better description of it than "just-in-time". I don't think "JAOT" is a well-known enough acronym, so it's worth spelling it out.
2020-04-20doc: HACKING: add a bit about faster testing
`make test' is annoyingly slow, and `make check-run' works wonders for improving the edit && test cycle.
2020-04-01doc: update notes and HACKING ahead of 1.4 release
There will probably be a 1.4 release in a few days...
2020-02-23doc: improve wording of "inbox" vs "repository"
Since v2 inboxes contain multiple git repositories, avoid the use of the word "repository" when referring to inboxes as a whole in most places.
2019-10-30HACKING: add a note about avoiding recursion
Bad things happen when user data can control our stack size.
2019-10-02HACKING: document Perl character class gotcha
It took me years to discover this change in Perl 5.6, maybe other potential hackers are in the same boat.
2019-09-22doc: update HACKING and TODO with a few items
Inline::C seems alright, so we might use it more since it still allows end users to quickly make changes. Our performance on rotational disks is also terrible, and could be improved...
2019-04-16HACKING: stop advertising mailing list subscription info
It's still available, but no point in advertising something which increases the dependency on a centralized subscriber list. In fact, it's actively against the goal of promoting resistance against centralization.
2019-01-11HACKING: update Debian version information
It's been a few years since this was updated...
2016-09-07doc: new docs for user-level commands
Hopefully more folks can download and run public-inbox, nowadays.
2016-08-16HACKING: minor updates and add to the website
Also, at least add one of the Tor mirrors (the rest will be discoverable through the mirrors themselves).
2016-01-06HACKING: more docs about our philosophy
Reiterating reasons behind what we do might help drive our point across better.
2016-01-04misc doc updates
Strongly emphasize decentralization, as that was actually the main impetus for my interest in git.
2015-12-26doc: minor updates to trim down the README
We'll continue developing and supporting ssoma, but it's unlikely to gain much adoption in its current form; so stop cluttering up our own README with it.
2014-04-21doc: update design_www and add HACKING file
Document some of the stranger choices I've made.