Page MenuHomeFreeBSD

developers-handbook: update shared libraries policy section
ClosedPublic

Authored by kib on Jul 18 2021, 1:54 PM.
Tags
None
Referenced Files
Unknown Object (File)
Jan 14 2024, 10:51 PM
Unknown Object (File)
Jan 11 2024, 1:37 AM
Unknown Object (File)
Dec 16 2023, 2:18 AM
Unknown Object (File)
Nov 10 2023, 10:45 PM
Unknown Object (File)
Nov 8 2023, 10:51 PM
Unknown Object (File)
Nov 8 2023, 7:31 PM
Unknown Object (File)
Nov 4 2023, 11:00 PM
Unknown Object (File)
Oct 29 2023, 5:53 AM

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
Lint Skipped
Unit
Tests Skipped

Event Timeline

kib requested review of this revision.Jul 18 2021, 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
301

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
308
309
310
311
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
300

I would write

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

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

309

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

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