Skip to content

Commit

Permalink
Links in Source Files
Browse files Browse the repository at this point in the history
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 <ryan@iXsystems.com>
Reviewed-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Spencer Kinny <spencerkinny1995@gmail.com>
Closes openzfs#5113 
Closes openzfs#10859
  • Loading branch information
Spencer-Kinny authored Sep 2, 2020
1 parent 0db1b84 commit 6fffc88
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 0 deletions.
3 changes: 3 additions & 0 deletions module/avl/avl.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 <sys/types.h>
Expand Down
9 changes: 9 additions & 0 deletions module/nvpair/nvpair.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 <sys/debug.h>
#include <sys/isa_defs.h>
#include <sys/nvpair.h>
Expand Down
4 changes: 4 additions & 0 deletions module/os/freebsd/spl/spl_kstat.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 <sys/cdefs.h>
Expand Down
4 changes: 4 additions & 0 deletions module/os/linux/spl/spl-kstat.c
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
* with the SPL. If not, see <http://www.gnu.org/licenses/>.
*
* 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 <linux/seq_file.h>
Expand Down

0 comments on commit 6fffc88

Please sign in to comment.