From a1aa40e4e02aa6284796e741310aceab23cc71b2 Mon Sep 17 00:00:00 2001 From: Patrick McDermott Date: Fri, 15 Mar 2019 00:25:00 -0400 Subject: ob_*_is_concerned(): Document --- diff --git a/lib/metadata.sh b/lib/metadata.sh index 11b8f8e..3aa399b 100644 --- a/lib/metadata.sh +++ b/lib/metadata.sh @@ -192,6 +192,17 @@ _ob_match_arch() return 0 } +## @brief Match a host architecture against an architecture field +## @details \fBob_arch_is_concerned\fP() checks whether a host architecture +## matches an architecture field. The host architecture may be either +## a specific distribution architecture or "all". The architecture +## field may be either a space-separated list of either "any" or +## specific distribution architectures, any of which can be negated +## with a prefix of "!", or "all". +## @operand host_arch req The host architecture to match. +## @operand arches req The architecture field against which to match. +## @return Returns 0 if \fIhost_arch\fP matches \fIarches\fP, or 0 if not. +## @pure yes This function has no side effects. ob_arch_is_concerned() { local host_arch="${1}" @@ -246,6 +257,17 @@ _ob_match_plat() return 1 } +## @brief Match a host platform against a platform field +## @details \fBob_plat_is_concerned\fP() checks whether a host platform matches +## a platform field. The host platform may be either a specific +## distribution platform or "all". The platform field may be either a +## space-separated list of either "any" or specific distribution +## platforms, any of which can be negated with a prefix of "!", or +## "all". +## @operand host_plat req The host platform to match. +## @operand plats req The platform field against which to match. +## @return Returns 0 if \fIhost_plat\fP matches \fIplats\fP, or 0 if not. +## @pure yes This function has no side effects. ob_plat_is_concerned() { local host_plat="${1}" -- cgit v0.9.1