Documentation
¶
Overview ¶
Command deprecated generates docs/DEPRECATED.md, a holistic overview of the driver's deprecated surface across all compat bundles.
It scans the driver source for files guarded by a go_hdb_compat_go1_NN build tag (see docs/DEPRECATIONS.md for the lifecycle), collects the exported declarations in those files together with their "Deprecated:" doc notes, and writes one Markdown document grouping every bundle by its flip release.
Run via go generate (see the directive in generate.go) or directly:
go run ./cmd/deprecated -root driver -out docs/DEPRECATED.md
Click to show internal directories.
Click to hide internal directories.