public inbox for linux-wireless@vger.kernel.org
 help / color / mirror / Atom feed
From: Seth Forshee <seth.forshee@canonical.com>
To: linux-wireless@vger.kernel.org, wireless-regdb@lists.infradead.org
Cc: Johannes Berg <johannes@sipsolutions.net>
Subject: [PATCH 6/6] wireless-regdb: Document regulatory.db in the manual page
Date: Fri, 22 Dec 2017 00:03:03 -0600	[thread overview]
Message-ID: <20171222060303.14478-7-seth.forshee@canonical.com> (raw)
In-Reply-To: <20171222060303.14478-1-seth.forshee@canonical.com>

Add information about regulatory.db to the regulatory.bin man
page, and alias the regulatory.db man page to refer to the page
for regulatory.bin.

Signed-off-by: Seth Forshee <seth.forshee@canonical.com>
---
 Makefile         |  2 +-
 regulatory.bin.5 | 32 ++++++++++++++++++++++----------
 regulatory.db.5  |  1 +
 3 files changed, 24 insertions(+), 11 deletions(-)
 create mode 100644 regulatory.db.5

diff --git a/Makefile b/Makefile
index 1e8e84c64149..2f1ed93e0e15 100644
--- a/Makefile
+++ b/Makefile
@@ -126,4 +126,4 @@ install: regulatory.bin.5.gz regulatory.db.5.gz
 	install -m 644 -t $(DESTDIR)/$(CRDA_PATH)/ regulatory.bin
 	install -m 644 -t $(DESTDIR)/$(FIRMWARE_PATH) regulatory.db regulatory.db.p7s
 	install -m 755 -d $(DESTDIR)/$(MANDIR)/man5/
-	install -m 644 -t $(DESTDIR)/$(MANDIR)/man5/ regulatory.bin.5.gz
+	install -m 644 -t $(DESTDIR)/$(MANDIR)/man5/ regulatory.bin.5.gz regulatory.db.5.gz
diff --git a/regulatory.bin.5 b/regulatory.bin.5
index 430c65c9ce6d..b1862cd1756d 100644
--- a/regulatory.bin.5
+++ b/regulatory.bin.5
@@ -1,6 +1,6 @@
-.TH regulatory.bin 5 "23 January 2009" "regulatory.bin" "Linux"
+.TH regulatory.bin 5 "21 December 2017" "regulatory.bin" "Linux"
 .SH NAME
-regulatory.bin \- The Linux wireless regulatory database
+regulatory.bin, regulatory.db \- The Linux wireless regulatory database
 
 .ad l
 .in +8
@@ -9,24 +9,36 @@ regulatory.bin \- The Linux wireless regulatory database
 .SS
 .SH Description
 .B regulatory.bin
-is the file used by the Linux wireless subsystem to keep its regulatory
-database information. It is read by
+and
+.B regulatory.db
+are the files used by the Linux wireless subsystem to keep its regulatory
+database information.
+.PP
+.B regulatory.bin
+is read by
 .B crda
 upon the Linux kernel's request for regulatory information for a specific
-ISO / IEC 3166 alpha2 country code. The regulatory database is kept in
-a small binary format for size and code efficiency. The
+ISO / IEC 3166 alpha2 country code.
+.PP
+.B regulatory.db
+is a newer, extensible database format which (since Linux 4.15) is read
+by the kernel directly as a firmware file.
+
+The regulatory database is kept in a small binary format for size and code
+efficiency. The
 .B regulatory.bin
 file can be parsed and read in human format by using the
 .B regdbdump
-command. The
-.B regulatory.bin
-file should be updated upon regulatory changes or corrections.
+command. The regulatory database files should be updated upon regulatory
+changes or corrections.
 
 .SH Upkeeping
 The regulatory database is maintained by the community as such
 you are encouraged to send any corrections or updates to the
-linux-wireless mailing list:
+linux-wireless and wireless-regdb mailing lists:
 .B linux-wireless@vger.kernel.org
+and
+.B wireless-regdb@lists.infradead.org
 
 .SH SEE ALSO
 .BR regdbdump (8)
diff --git a/regulatory.db.5 b/regulatory.db.5
new file mode 100644
index 000000000000..6c8aae374621
--- /dev/null
+++ b/regulatory.db.5
@@ -0,0 +1 @@
+.so man5/regulatory.bin.5.gz
-- 
2.14.1

  parent reply	other threads:[~2017-12-22  6:03 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-12-22  6:02 [PATCH 0/6] wireless-regdb: Support for new binary database format Seth Forshee
2017-12-22  6:02 ` [PATCH 1/6] regdb: write firmware file format (version code 20) Seth Forshee
2017-12-22  6:02 ` [PATCH 2/6] wireless-regdb: Restore generation of old format database files Seth Forshee
2017-12-22  6:03 ` [PATCH 3/6] wireless-regdb: Add sforshee's x509 certificate Seth Forshee
2017-12-22  6:03 ` [PATCH 4/6] wireless-regdb: Better support for generating public certificates Seth Forshee
2017-12-22  6:03 ` [PATCH 5/6] wireless-regdb: Install regulatory.db and regulatory.db.p7s to /lib/firmware Seth Forshee
2017-12-22  6:03 ` Seth Forshee [this message]
2017-12-22  8:45 ` [PATCH 0/6] wireless-regdb: Support for new binary database format Johannes Berg
2017-12-24  3:24 ` Seth Forshee

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171222060303.14478-7-seth.forshee@canonical.com \
    --to=seth.forshee@canonical.com \
    --cc=johannes@sipsolutions.net \
    --cc=linux-wireless@vger.kernel.org \
    --cc=wireless-regdb@lists.infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox