From patchwork Fri Dec 22 06:03:03 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Seth Forshee X-Patchwork-Id: 10128823 X-Patchwork-Delegate: kvalo@adurom.com Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork.web.codeaurora.org (Postfix) with ESMTP id D1F306019D for ; Fri, 22 Dec 2017 06:03:29 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id C3732298AA for ; Fri, 22 Dec 2017 06:03:29 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id B819229909; Fri, 22 Dec 2017 06:03:29 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.9 required=2.0 tests=BAYES_00,RCVD_IN_DNSWL_HI autolearn=ham version=3.3.1 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 4655929FA4 for ; Fri, 22 Dec 2017 06:03:29 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1752797AbdLVGDZ (ORCPT ); Fri, 22 Dec 2017 01:03:25 -0500 Received: from youngberry.canonical.com ([91.189.89.112]:38705 "EHLO youngberry.canonical.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752626AbdLVGDS (ORCPT ); Fri, 22 Dec 2017 01:03:18 -0500 Received: from mail-it0-f70.google.com ([209.85.214.70]) by youngberry.canonical.com with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.76) (envelope-from ) id 1eSGQP-0002fB-Q0 for linux-wireless@vger.kernel.org; Fri, 22 Dec 2017 06:03:17 +0000 Received: by mail-it0-f70.google.com with SMTP id c33so9795764itf.8 for ; Thu, 21 Dec 2017 22:03:17 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=6Ffe370a/2JSRfGpyO26dnPgvDgC6LE9XE7IOS7CV5c=; b=OthgC2BtQs2OQ7ba+sllYU0A/5ycPOsdj9VaqbY+JmUUAsTrkddzR2WiOj2LmfRZJF RD+4yTW7Tylaxj7YdliqzUL1VVvHuNTGmvbIAw/tCHY0UIdPGW3Q6Lrx3QTjVl3bIJuv H+iHNiJXV/kaG8nJEJg4KGahz97MzuOhoxJRgmfctKP+pitKI+h548jKRRqwOXfXWtql lqoE7t+0iHaB2SRZIrKj/bplfZMff8HQ/l9h6k5CMbbcAhBEvqPQBh2MYO8PGZV00cU8 LVj579zp+PegKA0gjcg2v5HhRw2urUZ//c3rniB+GPmWI4XXWUgHmR9/kMl+GsnbroOs EPPQ== X-Gm-Message-State: AKGB3mL9QSXNrSjYeaVaqJVevsoLCT7o23hPWNDm7uBg8mp8BFBcVpOn 60MC2gbFK9615h78+MDeFNMHbfiPhGt6ChrQ5+C21q0+EOqCXbEvyIMSYaDaE6eOUWPCJ7AaaPs v4ApNpdXPmbSA0n8dB/RXzixAue57odCZFiSICmC3EPh2 X-Received: by 10.36.244.78 with SMTP id u14mr16357869iti.151.1513922596305; Thu, 21 Dec 2017 22:03:16 -0800 (PST) X-Google-Smtp-Source: ACJfBovcEp3DdYkYFOpKrQZMh2xqVQTIU2mQ26iLG9QFluxal1A1Em0zXTClB7Zllmj8GjrhKnwGKQ== X-Received: by 10.36.244.78 with SMTP id u14mr16357844iti.151.1513922595994; Thu, 21 Dec 2017 22:03:15 -0800 (PST) Received: from localhost ([2605:a601:aae:1b20:ed05:64dd:188e:d39c]) by smtp.gmail.com with ESMTPSA id 140sm8090870itx.3.2017.12.21.22.03.15 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 21 Dec 2017 22:03:15 -0800 (PST) From: Seth Forshee To: linux-wireless@vger.kernel.org, wireless-regdb@lists.infradead.org Cc: Johannes Berg Subject: [PATCH 6/6] wireless-regdb: Document regulatory.db in the manual page Date: Fri, 22 Dec 2017 00:03:03 -0600 Message-Id: <20171222060303.14478-7-seth.forshee@canonical.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20171222060303.14478-1-seth.forshee@canonical.com> References: <20171222060303.14478-1-seth.forshee@canonical.com> Sender: linux-wireless-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-wireless@vger.kernel.org X-Virus-Scanned: ClamAV using ClamSMTP 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 --- 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