document some of the source files

This commit is contained in:
Ted Unangst 2020-04-19 20:29:08 -04:00
parent 578e9c9351
commit 7111e8a93d
1 changed files with 53 additions and 0 deletions

View File

@ -24,5 +24,58 @@ The vital improvements module,
.Nm , .Nm ,
is used to customize and extend honk in such rare cases as the is used to customize and extend honk in such rare cases as the
existing functionality proves insufficient. existing functionality proves insufficient.
.Ss Files
.Bl -tag -width deliverator.go
.It activity.go
Conversion to and from ActivityPub format and interop with other
implementations.
.It admin.go
The console admin interface.
.It avatar.go
Code to generate blocky avatar images.
.It backend.go
Interface to the image resizing backend helper process.
.It bloat.go
Bad stuff.
.It database.go
Loading and saving things to database.
.It deliverator.go
Sending messages and handling retries.
.It fun.go
All sorts of fun stuff.
.It hfcs.go
Filtering framework.
.It honk.go
Just a few data types.
.It hoot.go
Twitter scraper.
.It import.go
Importers from other service data dumps.
.It markitzero.go
Markdown converter.
.It schema.go
Generated from schema.sql.
.It sensors.go
Monitor memory and CPU.
.It skulduggery.go
Reduce some stupidity.
.It unveil.go
OpenBSD pledge and unveil.
.It upgradedb.go
Upgrade between schema versions.
.It util.go
Boring code.
.It web.go
The web interface.
.El
.Ss Schema
The current schema is stored in
.Pa schema.sql .
.Pp
After changing the schema, edit
.Pa upgradedb.go
to update
.Va myVersion
and add relevant update statements to the bottom of the large switch.
.Sh SEE ALSO .Sh SEE ALSO
.Xr honk 3 .Xr honk 3