]> www.infradead.org Git - users/dwmw2/linux.git/commit
lib: packing: document recently added APIs
authorJacob Keller <jacob.e.keller@intel.com>
Tue, 10 Dec 2024 20:27:13 +0000 (12:27 -0800)
committerJakub Kicinski <kuba@kernel.org>
Thu, 12 Dec 2024 04:13:00 +0000 (20:13 -0800)
commita9ad2a8dfb436c55607c8038aa926f55a6d6ca8e
treee4277d9ac47b81a739e9c6137609ad1d799e324e
parent41d7ea30494cc0dde3e124a75ce0add93f988ba9
lib: packing: document recently added APIs

Extend the documentation for the packing library, covering the intended use
for the recently added APIs. This includes the pack() and unpack() macros,
as well as the pack_fields() and unpack_fields() macros.

Add a note that the packing() API is now deprecated in favor of pack() and
unpack().

For the pack_fields() and unpack_fields() APIs, explain the rationale for
when a driver may want to select this API. Provide an example which shows
how to define the fields and call the pack_fields() and unpack_fields()
macros.

Co-developed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Signed-off-by: Jacob Keller <jacob.e.keller@intel.com>
Reviewed-by: Vladimir Oltean <vladimir.oltean@nxp.com>
Link: https://patch.msgid.link/20241210-packing-pack-fields-and-ice-implementation-v10-4-ee56a47479ac@intel.com
Signed-off-by: Jakub Kicinski <kuba@kernel.org>
Documentation/core-api/packing.rst