From 6fffc88bf389e6ae74c88b4e74d04869bf413e41 Mon Sep 17 00:00:00 2001 From: Spencer Kinny <30333052+Spencer-Kinny@users.noreply.github.com> Date: Wed, 2 Sep 2020 22:12:12 +0530 Subject: [PATCH] Links in Source Files Added comments in following files with links to Illumos manual pages: ./module/avl/avl.c ./module/nvpair/nvpair.c ./module/os/linux/spl/spl-kstat.c ./module/os/freebsd/spl/spl_kstat.c Reviewed-by: Ryan Moeller Reviewed-by: Brian Behlendorf Signed-off-by: Spencer Kinny Closes #5113 Closes #10859 --- module/avl/avl.c | 3 +++ module/nvpair/nvpair.c | 9 +++++++++ module/os/freebsd/spl/spl_kstat.c | 4 ++++ module/os/linux/spl/spl-kstat.c | 4 ++++ 4 files changed, 20 insertions(+) diff --git a/module/avl/avl.c b/module/avl/avl.c index 9cc8362399..48865365d8 100644 --- a/module/avl/avl.c +++ b/module/avl/avl.c @@ -96,6 +96,9 @@ * which each have their own compilation environments and subsequent * requirements. Each of these environments must be considered when adding * dependencies from avl.c. + * + * Link to Illumos.org for more information on avl function: + * [1] https://illumos.org/man/9f/avl */ #include diff --git a/module/nvpair/nvpair.c b/module/nvpair/nvpair.c index 20a58802f6..990a4482c9 100644 --- a/module/nvpair/nvpair.c +++ b/module/nvpair/nvpair.c @@ -25,6 +25,15 @@ * Copyright 2018 RackTop Systems. */ +/* + * Links to Illumos.org for more information on Interface Libraries: + * [1] https://illumos.org/man/3lib/libnvpair + * [2] https://illumos.org/man/3nvpair/nvlist_alloc + * [3] https://illumos.org/man/9f/nvlist_alloc + * [4] https://illumos.org/man/9f/nvlist_next_nvpair + * [5] https://illumos.org/man/9f/nvpair_value_byte + */ + #include #include #include diff --git a/module/os/freebsd/spl/spl_kstat.c b/module/os/freebsd/spl/spl_kstat.c index 92a18de63f..df2da2d602 100644 --- a/module/os/freebsd/spl/spl_kstat.c +++ b/module/os/freebsd/spl/spl_kstat.c @@ -22,6 +22,10 @@ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. + * + * Links to Illumos.org for more information on kstat function: + * [1] https://illumos.org/man/1M/kstat + * [2] https://illumos.org/man/9f/kstat_create */ #include diff --git a/module/os/linux/spl/spl-kstat.c b/module/os/linux/spl/spl-kstat.c index b971b4498c..b9eeb332ee 100644 --- a/module/os/linux/spl/spl-kstat.c +++ b/module/os/linux/spl/spl-kstat.c @@ -22,6 +22,10 @@ * with the SPL. If not, see . * * Solaris Porting Layer (SPL) Kstat Implementation. + * + * Links to Illumos.org for more information on kstat function: + * [1] https://illumos.org/man/1M/kstat + * [2] https://illumos.org/man/9f/kstat_create */ #include