From owner-freebsd-doc@freebsd.org Wed Dec 19 09:43:26 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 D497513520FC for ; Wed, 19 Dec 2018 09:43:25 +0000 (UTC) (envelope-from dschroetter@gmail.com) Received: from mail-wr1-x429.google.com (mail-wr1-x429.google.com [IPv6:2a00:1450:4864:20::429]) (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 BEB3572514; Wed, 19 Dec 2018 09:43:24 +0000 (UTC) (envelope-from dschroetter@gmail.com) Received: by mail-wr1-x429.google.com with SMTP id r10so18752837wrs.10; Wed, 19 Dec 2018 01:43:24 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=XL9P9BfYEOAb7hm52Wq/ZINiLxiz8H7Hjgo4oQLFWTg=; b=E7Ie6H+PWz2Kzy4IHXpDh4eqJ26EEh8roQyXV08mDcpR7Wr43CMqzDVQpS1umhBktK G0KFrCAvTRAqhlAqexXMtPysoxq0n3rJ35ljRbUx8duY//iEknFqJ3xOkOSNyURDLu+m Ddq+uA5Ef/4dmudhsX1DisW4W6Gkk0B8T369qiWE+L51csSnv3te3YGvBAvVwVs0KYkz GVQUNC9j3rJLnZxYd7PivlmivdAkaEsjlvKZUc5w4TOa4ggNB2yew7NWMXBTE3JS7XVJ DYg0Wxnrs0ZfA8dcGsCqXIRDTwY/802kzIZDeuj6hzgnIgZnpxQGgEvLb/f5vW3V5Mht gEyg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:mime-version:subject:from:in-reply-to:date:cc :content-transfer-encoding:message-id:references:to; bh=XL9P9BfYEOAb7hm52Wq/ZINiLxiz8H7Hjgo4oQLFWTg=; b=Kmupdai5jIX3Ox3IFAYLeM4VuQoHbLEpaT9k5xJpjpTL8/mbVN9ATIEMX/wtTToCXG gZ0WOPRWV3AwF3aOQzKXrxMeGhnkrHWDOPqK1CDOTQQ7KQmknN3BojEDxz5JuE4nXeC7 mS3Ef9okT1hqYBjmKjNaTV0bSqTWViqkRxu2H2dqW1ascOK4XFn0ghi6t708DmLtiktv wZFPVu8dxciMlmCKHlTEvWrkMd8HRK9xJ2tADEZhatzZr19O4e1VZAdVbtXm7U2blOil eRoEVdDx4SGTpVi0Y++wMqa3zrNVbkZGdvbqqR5DL/sUxB8y8S8zEGZVunuQk7hmXmGI 4Bzw== X-Gm-Message-State: AA+aEWbJsX/R6gbT2VQS4ayErkhoYkjpjKemLU/Dpnf/Ktq6gMgWWJL0 o16S2OiPazNqqTvDaaoHOLTZ+oHN X-Google-Smtp-Source: AFSGD/X4zMMg5mwZcxAsBgCUFJVV8hyMS85jqoNWKgiQgPbweUQTv7858KXDck9oNanGKk/a1KZV5g== X-Received: by 2002:adf:bb44:: with SMTP id x4mr18534931wrg.24.1545212603320; Wed, 19 Dec 2018 01:43:23 -0800 (PST) Received: from [192.168.0.30] (p50973634.dip0.t-ipconnect.de. [80.151.54.52]) by smtp.gmail.com with ESMTPSA id 62sm5502407wra.30.2018.12.19.01.43.22 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 19 Dec 2018 01:43:22 -0800 (PST) Content-Type: text/plain; charset=utf-8 Mime-Version: 1.0 (1.0) Subject: Re: Options, devices, hints - Documentation work needed ? From: Dirk Schroetter X-Mailer: iPad Mail (16B92) In-Reply-To: Date: Wed, 19 Dec 2018 10:43:21 +0100 Cc: freebsd-doc@FreeBSD.org Content-Transfer-Encoding: quoted-printable Message-Id: References: To: Benedict Reuschling X-Rspamd-Queue-Id: BEB3572514 X-Spamd-Bar: ---- Authentication-Results: mx1.freebsd.org; dkim=pass header.d=gmail.com header.s=20161025 header.b=E7Ie6H+P; dmarc=pass (policy=none) header.from=gmail.com; spf=pass (mx1.freebsd.org: domain of dschroetter@gmail.com designates 2a00:1450:4864:20::429 as permitted sender) smtp.mailfrom=dschroetter@gmail.com X-Spamd-Result: default: False [-4.93 / 15.00]; RCVD_VIA_SMTP_AUTH(0.00)[]; TO_DN_SOME(0.00)[]; R_SPF_ALLOW(-0.20)[+ip6:2a00:1450:4000::/36]; MV_CASE(0.50)[]; FREEMAIL_FROM(0.00)[gmail.com]; RCVD_COUNT_THREE(0.00)[3]; MX_GOOD(-0.01)[cached: alt3.gmail-smtp-in.l.google.com]; DKIM_TRACE(0.00)[gmail.com:+]; RCPT_COUNT_TWO(0.00)[2]; NEURAL_HAM_SHORT(-0.99)[-0.987,0]; DMARC_POLICY_ALLOW(-0.50)[gmail.com,none]; FROM_EQ_ENVFROM(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)[]; DWL_DNSWL_NONE(0.00)[gmail.com.dwl.dnswl.org : 127.0.5.0]; ARC_NA(0.00)[]; NEURAL_HAM_MEDIUM(-1.00)[-1.000,0]; R_DKIM_ALLOW(-0.20)[gmail.com:s=20161025]; 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]; MIME_TRACE(0.00)[0:+]; RCVD_TLS_LAST(0.00)[]; RCVD_IN_DNSWL_NONE(0.00)[9.2.4.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]; IP_SCORE(-2.43)[ip: (-9.11), ipnet: 2a00:1450::/32(-1.58), asn: 15169(-1.38), country: US(-0.08)] 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: Wed, 19 Dec 2018 09:43:26 -0000 Hello Benedict, I was wondering if you already had a chance to look over the output I sent a= few days back and maybe already have a view on how to use that to the. Maxi= mum benefit of the community. Best Regards, /Dirk > Am 03.12.2018 um 18:57 schrieb Benedict Reuschling : >=20 > Hello Dirk, >=20 > I think this is definitely valueable in multiple ways: >=20 > - finding missing entries in NOTES or lacking a man page (as you noted) > - adding cross references and notes to existing man pages (when appropriat= e) > - checking if all these options are needed or are included implicitly > during kernel builds > - identifying outdated information or obsolete entries >=20 > Cross references will help developers understanding how things are > interconnected within the kernel and the source tree. >=20 > I'm just wondering what kind of format would be appropriate for the > table. It could be a big table on the FreeBSD wiki, but it could also be > part of the developers handbook or a separate article. Can you send us > an excerpt so that we can see how it looks like? It does not have to be > fancy, just to get a feel for the information in it. >=20 > I could help out from the doc side of things and we should definitely > find someone from the kernel side to confirm that the findings make sense.= >=20 > Thanks! >=20 > Cheers, > Benedict >=20 >=20 >=20 >> Am 03.12.18 um 17:52 schrieb Dirk Schroetter: >> Hello there, >>=20 >> I am just working on my kernel and its config and after trying to find a c= omprehensive list of kernel options, I came up short. >>=20 >> So I did fire up the editor and managed to get a python script running th= at looks at: >>=20 >> * The =E2=80=9Aoptions=E2=80=98 files under /usr/src >> * The =E2=80=9ANOTES=E2=80=98 files >> * The manual pages >>=20 >> all this being dumped into a table and cross-referenced. >>=20 >> My current stat on a FreeBSD 11.2 AMD64: Around 1000 kernel options of wh= ich 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) >>=20 >> So I was going to try to compile some form of documentation for all of th= ese for my own personal use. Then I was wondering if the Documentation proje= ct had any use for this kind of information. My idea was: >>=20 >> 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. >>=20 >> It may be that this is a fool=E2=80=99s errand and much to big for a sing= le person, but I would volunteer to at least get it started, if you folks th= ink that there is any merit to it. >>=20 >> So that would be my proposal and I would love to hear back from you. >>=20 >> Best Regards, >>=20 >> /Dirk >> _______________________________________________ >> freebsd-doc@freebsd.org mailing list >> https://lists.freebsd.org/mailman/listinfo/freebsd-doc >> To unsubscribe, send any mail to "freebsd-doc-unsubscribe@freebsd.org" >>=20 >=20 >=20