From owner-freebsd-doc@freebsd.org Mon Dec 3 16:52:36 2018 Return-Path: Delivered-To: freebsd-doc@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 5E256132CBF3 for ; Mon, 3 Dec 2018 16:52:36 +0000 (UTC) (envelope-from dschroetter@gmail.com) Received: from mail-wm1-x32a.google.com (mail-wm1-x32a.google.com [IPv6:2a00:1450:4864:20::32a]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "smtp.gmail.com", Issuer "Google Internet Authority G3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id C33A18A3EB for ; Mon, 3 Dec 2018 16:52:34 +0000 (UTC) (envelope-from dschroetter@gmail.com) Received: by mail-wm1-x32a.google.com with SMTP id y1so6587150wmi.3 for ; Mon, 03 Dec 2018 08:52:34 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:content-transfer-encoding:mime-version:subject:message-id:date :to; bh=Y9D/eBbyhGCcvFVhPUpis+5RmaOnSOKzIcOsV/i/AKM=; b=L0sUgJHjSTDCsYL/TiAUr54ZVVna3XClD22RHk/kSaftluTOp7yQV86U1PQ7JwVS5m 6Ew1kg88WuaRunHaaYXtRg/I5IN6LhNEquIYhZOX3CQP0OLvjbB8PLG3t23rsR56t9bv FI+7uPByK71AtVIIho8JvgzDu9zGnNg1MR8n9W4tZhuKcFoIVJ9x+qHrIVJtUnSO+7BL k4jGydpjbt2g9PP6ZBsg7QRyLnT7nMfP5DpxymNfLH9tfjpWCk8VhHmyJUArfFlGw0WH lM2+2Vpu9GUkW00Yn6uddPjbXq8tF6+WgSTxskkFeiKpN7yQ3TRzvmhyJN6/up5kWpzd xdkQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:content-transfer-encoding:mime-version :subject:message-id:date:to; bh=Y9D/eBbyhGCcvFVhPUpis+5RmaOnSOKzIcOsV/i/AKM=; b=UkER+S2n7Tet+3YKoLgoK6WRIwxEqfNJ4hhrwPIGkpzE5pK66y2tUIV0EVh4EHrwgq 9GiEqbISCMLYzRavrY/n6Ey+Avdyj1aGCnx1TMTstHwn9y4sXTRENAK71Yg2sXWE8OAa T0RSAEgwlRFCcyNP4xB/6fk1FDC8xNS6zeWrAEAm//gkAECTMCmIFgpGMP8o7ObcmzFZ gUsfkoTaae107uHJVCiC0zQv783tyS1o0OjoblNbSnKlTRs9CmVQ7NJMYvKO5RW4fLiA dfKc4nLuKKXxofBQgkegKMNLAPznkXcpl+m3T34PosJGc+hFbk1GQ6c+rQl63RCZMs88 Wmog== X-Gm-Message-State: AA+aEWaIk7dn6CjmLux6mmsPGVYHhmerp/WkENVy0yQ7o4rs15EWLrAp yVXLQuUDaoZKubPLXwx5+GKZGhjz X-Google-Smtp-Source: AFSGD/U+J1tSB1OUZtlPUO2cGwleC3owEmVCFHXWEcO/5ygzTErP5v1q1vgzGJ2IZp4oeuKL+K6bTw== X-Received: by 2002:a1c:af89:: with SMTP id y131mr8982540wme.137.1543855953465; Mon, 03 Dec 2018 08:52:33 -0800 (PST) Received: from [192.168.0.20] (p50973634.dip0.t-ipconnect.de. [80.151.54.52]) by smtp.gmail.com with ESMTPSA id d2sm9103253wro.88.2018.12.03.08.52.32 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Mon, 03 Dec 2018 08:52:32 -0800 (PST) From: Dirk Schroetter Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Mime-Version: 1.0 (Mac OS X Mail 12.0 \(3445.100.39\)) Subject: Options, devices, hints - Documentation work needed ? Message-Id: Date: Mon, 3 Dec 2018 17:52:31 +0100 To: freebsd-doc@FreeBSD.org X-Mailer: Apple Mail (2.3445.100.39) X-Rspamd-Queue-Id: C33A18A3EB X-Spamd-Result: default: False [-4.94 / 15.00]; RCVD_VIA_SMTP_AUTH(0.00)[]; R_SPF_ALLOW(-0.20)[+ip6:2a00:1450:4000::/36]; MV_CASE(0.50)[]; TO_DN_NONE(0.00)[]; FREEMAIL_FROM(0.00)[gmail.com]; RCVD_COUNT_THREE(0.00)[3]; DKIM_TRACE(0.00)[gmail.com:+]; MX_GOOD(-0.01)[cached: alt3.gmail-smtp-in.l.google.com]; DMARC_POLICY_ALLOW(-0.50)[gmail.com,none]; NEURAL_HAM_SHORT(-0.96)[-0.962,0]; FROM_EQ_ENVFROM(0.00)[]; RCVD_TLS_LAST(0.00)[]; SUBJECT_ENDS_QUESTION(1.00)[]; FREEMAIL_ENVFROM(0.00)[gmail.com]; ASN(0.00)[asn:15169, ipnet:2a00:1450::/32, country:US]; MID_RHS_MATCH_FROM(0.00)[]; ARC_NA(0.00)[]; NEURAL_HAM_MEDIUM(-1.00)[-1.000,0]; R_DKIM_ALLOW(-0.20)[gmail.com]; FROM_HAS_DN(0.00)[]; TO_MATCH_ENVRCPT_ALL(0.00)[]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; MIME_GOOD(-0.10)[text/plain]; PREVIOUSLY_DELIVERED(0.00)[freebsd-doc@freebsd.org]; RCPT_COUNT_ONE(0.00)[1]; IP_SCORE(-2.46)[ip: (-9.51), ipnet: 2a00:1450::/32(-1.42), asn: 15169(-1.30), country: US(-0.09)]; RCVD_IN_DNSWL_NONE(0.00)[a.2.3.0.0.0.0.0.0.0.0.0.0.0.0.0.0.2.0.0.4.6.8.4.0.5.4.1.0.0.a.2.list.dnswl.org : 127.0.5.0] X-Rspamd-Server: mx1.freebsd.org X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 03 Dec 2018 16:52:36 -0000 Hello there, I am just working on my kernel and its config and after trying to find a = comprehensive list of kernel options, I came up short. So I did fire up the editor and managed to get a python script running = that looks at: * The =E2=80=9Aoptions=E2=80=98 files under /usr/src * The =E2=80=9ANOTES=E2=80=98 files * The manual pages all this being dumped into a table and cross-referenced. My current stat on a FreeBSD 11.2 AMD64: Around 1000 kernel options of = which around half do not have either an entry in NOTES or are not = mentioned on a man page (e.g. ACPI_MAX_TAKS or ADA_TEST_FAILURE) So I was going to try to compile some form of documentation for all of = these for my own personal use. Then I was wondering if the Documentation = project had any use for this kind of information. My idea was: 1. Try to get the information into the respective NOTES files. 2. Make sure the options, devices, hints get into the option.h files 3. Updating the man pages. It may be that this is a fool=E2=80=99s errand and much to big for a = single person, but I would volunteer to at least get it started, if you = folks think that there is any merit to it. So that would be my proposal and I would love to hear back from you. Best Regards, /Dirk=