Skip to content

Commit

Permalink
modules/udev: Add module comments
Browse files Browse the repository at this point in the history
* modules/udev/device.scm, modules/udev/hwdb.scm, modules/udev/monitor.scm,
  modules/udev/udev.scm: Add module commentary.
  • Loading branch information
artyom-poptsov committed Dec 21, 2023
1 parent b2618d5 commit d3b9828
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 0 deletions.
32 changes: 32 additions & 0 deletions modules/udev/device.scm
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
;;; device.scm -- Udev device procedures.
;;
;; Copyright (C) 2020-2023 Artyom V. Poptsov <[email protected]>
;; Copyright (C) 2023 Maxim Cournoyer <[email protected]>
;;
;; This file is part of Guile-Udev.
;;
;; Guile-Udev is free software: you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free
;; Software Foundation, either version 3 of the License, or (at your option)
;; any later version.
;;
;; Guile-Udev is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
;; more details.
;;
;; You should have received a copy of the GNU General Public License along
;; with Guile-Udev. If not, see <http://www.gnu.org/licenses/>.


;;; Commentary:

;; This module contains procedures for working with Udev devices.


;;; Code:

(define-module (udev device)
#:export (udev-device
udev-device?
Expand All @@ -13,4 +41,8 @@
udev-device-get-properties
udev-device-get-tags))


(load-extension "libguile-udev" "init_udev_device")

;;; device.scm ends here.

32 changes: 32 additions & 0 deletions modules/udev/hwdb.scm
Original file line number Diff line number Diff line change
@@ -1,7 +1,39 @@
;;; hwdb.scm -- Udev hardware database procedures.
;;
;; Copyright (C) 2020-2023 Artyom V. Poptsov <[email protected]>
;;
;; This file is part of Guile-Udev.
;;
;; Guile-Udev is free software: you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free
;; Software Foundation, either version 3 of the License, or (at your option)
;; any later version.
;;
;; Guile-Udev is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
;; more details.
;;
;; You should have received a copy of the GNU General Public License along
;; with Guile-Udev. If not, see <http://www.gnu.org/licenses/>.


;;; Commentary:

;; This module contains procedures for interacting with the Udev hardware
;; database.


;;; Code:

(define-module (udev hwdb)
#:export (udev-hwdb
udev-hwdb?
make-udev-hwdb
udev-hwdb-lookup))


(load-extension "libguile-udev" "init_udev_hwdb")

;;; hwdb.scm ends here.

31 changes: 31 additions & 0 deletions modules/udev/monitor.scm
Original file line number Diff line number Diff line change
@@ -1,3 +1,31 @@
;;; monitor.scm -- Udev monitor procedures.
;;
;; Copyright (C) 2020-2023 Artyom V. Poptsov <[email protected]>
;; Copyright (C) 2023 Maxim Cournoyer <[email protected]>
;;
;; This file is part of Guile-Udev.
;;
;; Guile-Udev is free software: you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free
;; Software Foundation, either version 3 of the License, or (at your option)
;; any later version.
;;
;; Guile-Udev is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
;; more details.
;;
;; You should have received a copy of the GNU General Public License along
;; with Guile-Udev. If not, see <http://www.gnu.org/licenses/>.


;;; Commentary:

;; This module contains procedures for working with Udev monitors.


;;; Code:

(define-module (udev monitor)
#:export (udev-monitor
udev-monitor?
Expand All @@ -12,6 +40,7 @@
udev-monitor-stop-scanning!
udev-monitor-get-udev))


;; A high-level procedure that creates a new udev monitor instance with the
;; specified parameters.
(define* (make-udev-monitor udev
Expand Down Expand Up @@ -42,3 +71,5 @@ or #f to match any type."
monitor))

(load-extension "libguile-udev" "init_udev_monitor")

;;; monitor.scm ends here.
30 changes: 30 additions & 0 deletions modules/udev/udev.scm
Original file line number Diff line number Diff line change
@@ -1,6 +1,36 @@
;;; udev.scm -- Udev procedures.
;;
;; Copyright (C) 2020-2023 Artyom V. Poptsov <[email protected]>
;;
;; This file is part of Guile-Udev.
;;
;; Guile-Udev is free software: you can redistribute it and/or modify it under
;; the terms of the GNU General Public License as published by the Free
;; Software Foundation, either version 3 of the License, or (at your option)
;; any later version.
;;
;; Guile-Udev is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
;; FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
;; more details.
;;
;; You should have received a copy of the GNU General Public License along
;; with Guile-Udev. If not, see <http://www.gnu.org/licenses/>.


;;; Commentary:

;; This module contains procedures for working with Udev instances.


;;; Code:

(define-module (udev udev)
#:export (udev
udev?
make-udev))


(load-extension "libguile-udev" "init_udev")

;;; udev.scm ends here.

0 comments on commit d3b9828

Please sign in to comment.