Page MenuHomeFreeBSD

developers-handbook: update shared libraries policy section
ClosedPublic

Authored by kib on Sun, Jul 18, 1:54 PM.

Details

Summary

Current text was written with a.out shared libraries system in mind, which is not adequate for ELF system. In fact it can be considered as mis-information causing to spread false rumors about FreeBSD environment.

Drop everything that comes from a.out world, and briefly describe common conventions related to ELF shared objects.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

kib requested review of this revision.Sun, Jul 18, 1:54 PM
kib created this revision.

Note: I don't know what the current policy and practice are, so I can't comment on how accurately the change reflects them.

documentation/content/en/books/developers-handbook/policies/_index.adoc
292–293
295
300

I'd change "argumentation" to either "arguments" or "reasons"

305
307–311

Also, 1 sentence per line? I think doc people settled on that.

kib marked 5 inline comments as done.

Some grammar.

documentation/content/en/books/developers-handbook/policies/_index.adoc
307
308
309
310
kib marked 4 inline comments as done.

More grammar.

lgtm, a couple of minor items that you could consider

documentation/content/en/books/developers-handbook/policies/_index.adoc
299

I would write

  • If this is impossible, or the library does not use symbol versioning, bump the library version
300

perhaps spell out Release Engineering, lowercase re looks like a fragment of a missing word

308

I might use libexample.so.x.y rather than libmy.so.x.y

This revision is now accepted and ready to land.Tue, Jul 27, 7:11 PM
kib marked 3 inline comments as done.Tue, Jul 27, 7:47 PM