All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Theodore Ts'o" <tytso@mit.edu>
To: Constantine Shulyupin <constantine.shulyupin@gmail.com>
Cc: erik@flodin.me, catalin.marinas@arm.com,
	linus.walleij@linaro.org, hch@lst.de, siyanteng@loongson.cn,
	mpe@ellerman.id.au, aaptel@suse.com, cw00.choi@samsung.com,
	stern@rowland.harvard.edu, shy828301@gmail.com,
	Guenter Roeck <linux@roeck-us.net>,
	kubernat@cesnet.cz, pmladek@suse.com, npiggin@gmail.com,
	mic@linux.microsoft.com, eric.auger@redhat.com,
	alex.williamson@redhat.com, jonas@protocubo.io,
	skhan@linuxfoundation.org, tglx@linutronix.de, sozeri@habana.ai,
	gregkh@linuxfoundation.org, jianyong.wu@arm.com,
	gi-oh.kim@ionos.com, hverkuil-cisco@xs4all.nl,
	gi-oh.kim@cloud.ionos.com, torvalds@linux-foundation.org,
	georgi.djakov@linaro.org, macro@orcam.me.uk,
	hengqi.chen@gmail.com, aquini@redhat.com,
	linux-doc@vger.kernel.org, yuchao0@huawei.com,
	stephane.blondon@gmail.com,
	James.Bottomley@hansenpartnership.com, kabel@kernel.org,
	unixbhaskar@gmail.com,
	kernelnewbies <kernelnewbies@kernelnewbies.org>,
	bernard@vivo.com, rafael.j.wysocki@intel.com,
	jamorris@linux.microsoft.com, jgg@nvidia.com,
	mszeredi@redhat.com, wilken.gottwalt@posteo.net,
	chris.packham@alliedtelesis.co.nz, jaegeuk@kernel.org,
	aisheng.dong@nxp.com, niklas.soderlund+renesas@ragnatech.se,
	tom.zanussi@linux.intel.com, mathieu.poirier@linaro.org,
	Gustavo.Pimentel@synopsys.com, marcan@marcan.st,
	sean.j.christopherson@intel.com, jarkko@kernel.org,
	yangbo.lu@nxp.com, mkl@pengutronix.de, stfrench@microsoft.com,
	heikki.krogerus@linux.intel.com, brijesh.singh@amd.com,
	dlatypov@google.com, linux@rasmusvillemoes.dk, ast@kernel.org,
	sebastian.reichel@collabora.com, festevam@gmail.com,
	natet@google.com, daniel@iogearbox.net,
	Jonathan Corbet <corbet@lwn.net>,
	masahiroy@kernel.org, haren@linux.ibm.com, willy@infradead.org,
	federico.vaga@vaga.pv.it, yuzenghui@huawei.com,
	keescook@chromium.org, Arnd Bergmann <arnd@arndb.de>,
	schnelle@linux.ibm.com, andreyknvl@google.com,
	broonie@kernel.org, bp@alien8.de, i@zenithal.me,
	nicolas.dichtel@6wind.com, pcc@google.com, sumit.garg@linaro.org,
	sakari.ailus@linux.intel.com, davem@davemloft.net,
	sbhat@linux.ibm.com, peterz@infradead.org, linux@leemhuis.info,
	dhowells@redhat.com, tamar.mashiah@intel.com,
	yangtiezhu@loongson.cn, vincenzo.frascino@arm.com,
	dikshita@codeaurora.org, mchehab+huawei@kernel.org,
	maz@kernel.org, rppt@linux.ibm.com, vladyslavt@nvidia.com,
	kuba@kernel.org, eesposit@redhat.com,
	stanimir.varbanov@linaro.org, anshuman.khandual@arm.com,
	hca@linux.ibm.com, bobwxc@email.cn, hdegoede@redhat.com,
	parav@nvidia.com, davidgow@google.com,
	Jonathan.Cameron@huawei.com, alexandru.elisei@arm.com,
	vbabka@suse.cz, axboe@kernel.dk, srutherford@google.com,
	luzmaximilian@gmail.com, ogabbay@kernel.org, vkoul@kernel.org,
	erik.rosen@metormote.com, pbonzini@redhat.com, saeedm@nvidia.com
Subject: Re: Wikibook Linux kernel
Date: Thu, 6 May 2021 10:17:16 -0400	[thread overview]
Message-ID: <YJP6bH/RXxcd/0Xf@mit.edu> (raw)
In-Reply-To: <CAE7jHC_r86KNb_+beU10Vq3DU9wGA3X=sHpDjH-QQNrDGU5taw@mail.gmail.com>

On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
> Dear Linux kernel documentation writers and readers:
> 
> Writing Linux documentation is a huge complex collaborative process.
> To make it better I invite you to contribute to
> https://en.wikibooks.org/wiki/The_Linux_Kernel

There are some wiki's that are available at *.wiki.kernel.org.  For
example, ext4.wiki.kernel.org.  We've largely abandoned it, in favor
of using Documentation in the kernel sources, because if you leave it
"updated by anyone", unless you have people constantly watching for
spam or trash updates which have to be reverted, it quickly becomes a
mess.  Or you can keep tight control over who you give accounts to,
but then it doesn't get updated all that often.

Keeping the documentation in sync with the kernel sources means it's
much more likely for the documentation to be updated when the kernel
is updated, and so for example we've migrated:

https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout

to:

https://www.kernel.org/doc/html/latest/filesystems/ext4/index.html

with the sources available at:

https://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git/tree/Documentation/filesystems/ext4

... and been much happier with the result.

Cheers,

					- Ted

_______________________________________________
Kernelnewbies mailing list
Kernelnewbies@kernelnewbies.org
https://lists.kernelnewbies.org/mailman/listinfo/kernelnewbies

WARNING: multiple messages have this Message-ID (diff)
From: "Theodore Ts'o" <tytso@mit.edu>
To: Constantine Shulyupin <constantine.shulyupin@gmail.com>
Cc: linux-doc@vger.kernel.org,
	kernelnewbies <kernelnewbies@kernelnewbies.org>,
	aaptel@suse.com, aisheng.dong@nxp.com, alexandru.elisei@arm.com,
	alex.williamson@redhat.com, andreyknvl@google.com,
	anshuman.khandual@arm.com, aquini@redhat.com,
	Arnd Bergmann <arnd@arndb.de>,
	ast@kernel.org, axboe@kernel.dk, bernard@vivo.com,
	bobwxc@email.cn, bp@alien8.de, brijesh.singh@amd.com,
	broonie@kernel.org, catalin.marinas@arm.com,
	chris.packham@alliedtelesis.co.nz,
	Jonathan Corbet <corbet@lwn.net>,
	cw00.choi@samsung.com, daniel@iogearbox.net, davem@davemloft.net,
	davidgow@google.com, dhowells@redhat.com,
	dikshita@codeaurora.org, dlatypov@google.com,
	eesposit@redhat.com, eric.auger@redhat.com, erik@flodin.me,
	erik.rosen@metormote.com, federico.vaga@vaga.pv.it,
	festevam@gmail.com, georgi.djakov@linaro.org,
	gi-oh.kim@cloud.ionos.com, gi-oh.kim@ionos.com,
	gregkh@linuxfoundation.org, Gustavo.Pimentel@synopsys.com,
	haren@linux.ibm.com, hca@linux.ibm.com, hch@lst.de,
	hdegoede@redhat.com, heikki.krogerus@linux.intel.com,
	hengqi.chen@gmail.com, hverkuil-cisco@xs4all.nl, i@zenithal.me,
	jaegeuk@kernel.org, James.Bottomley@hansenpartnership.com,
	jamorris@linux.microsoft.com, jarkko@kernel.org, jgg@nvidia.com,
	jianyong.wu@arm.com, jonas@protocubo.io,
	Jonathan.Cameron@huawei.com, kabel@kernel.org,
	keescook@chromium.org, kuba@kernel.org, kubernat@cesnet.cz,
	linus.walleij@linaro.org, linux@leemhuis.info,
	linux@rasmusvillemoes.dk, Guenter Roeck <linux@roeck-us.net>,
	luzmaximilian@gmail.com, macro@orcam.me.uk, marcan@marcan.st,
	masahiroy@kernel.org, mathieu.poirier@linaro.org, maz@kernel.org,
	mchehab+huawei@kernel.org, mic@linux.microsoft.com,
	mkl@pengutronix.de, mpe@ellerman.id.au, mszeredi@redhat.com,
	natet@google.com, nicolas.dichtel@6wind.com,
	niklas.soderlund+renesas@ragnatech.se, npiggin@gmail.com,
	ogabbay@kernel.org, parav@nvidia.com, pbonzini@redhat.com,
	pcc@google.com, peterz@infradead.org, pmladek@suse.com,
	rafael.j.wysocki@intel.com, rppt@linux.ibm.com,
	saeedm@nvidia.com, sakari.ailus@linux.intel.com,
	sbhat@linux.ibm.com, schnelle@linux.ibm.com,
	sean.j.christopherson@intel.com, sebastian.reichel@collabora.com,
	shy828301@gmail.com, siyanteng@loongson.cn,
	skhan@linuxfoundation.org, sozeri@habana.ai,
	srutherford@google.com, stanimir.varbanov@linaro.org,
	stephane.blondon@gmail.com, stern@rowland.harvard.edu,
	stfrench@microsoft.com, sumit.garg@linaro.org,
	tamar.mashiah@intel.com, tglx@linutronix.de,
	tom.zanussi@linux.intel.com, torvalds@linux-foundation.org,
	unixbhaskar@gmail.com, vbabka@suse.cz, vincenzo.frascino@arm.com,
	vkoul@kernel.org, vladyslavt@nvidia.com,
	wilken.gottwalt@posteo.net, willy@infradead.org,
	yangbo.lu@nxp.com, yangtiezhu@loongson.cn, yuchao0@huawei.com,
	yuzenghui@huawei.com
Subject: Re: Wikibook Linux kernel
Date: Thu, 6 May 2021 10:17:16 -0400	[thread overview]
Message-ID: <YJP6bH/RXxcd/0Xf@mit.edu> (raw)
In-Reply-To: <CAE7jHC_r86KNb_+beU10Vq3DU9wGA3X=sHpDjH-QQNrDGU5taw@mail.gmail.com>

On Thu, May 06, 2021 at 01:58:35PM +0300, Constantine Shulyupin wrote:
> Dear Linux kernel documentation writers and readers:
> 
> Writing Linux documentation is a huge complex collaborative process.
> To make it better I invite you to contribute to
> https://en.wikibooks.org/wiki/The_Linux_Kernel

There are some wiki's that are available at *.wiki.kernel.org.  For
example, ext4.wiki.kernel.org.  We've largely abandoned it, in favor
of using Documentation in the kernel sources, because if you leave it
"updated by anyone", unless you have people constantly watching for
spam or trash updates which have to be reverted, it quickly becomes a
mess.  Or you can keep tight control over who you give accounts to,
but then it doesn't get updated all that often.

Keeping the documentation in sync with the kernel sources means it's
much more likely for the documentation to be updated when the kernel
is updated, and so for example we've migrated:

https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout

to:

https://www.kernel.org/doc/html/latest/filesystems/ext4/index.html

with the sources available at:

https://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git/tree/Documentation/filesystems/ext4

... and been much happier with the result.

Cheers,

					- Ted

  parent reply	other threads:[~2021-05-08 13:41 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-06 10:58 Wikibook Linux kernel Constantine Shulyupin
2021-05-06 10:58 ` Constantine Shulyupin
2021-05-06 11:28 ` Borislav Petkov
2021-05-06 11:28   ` Borislav Petkov
2021-05-06 12:00   ` Mauro Carvalho Chehab
2021-05-06 12:00     ` Mauro Carvalho Chehab
2021-05-06 11:57 ` Mike Rapoport
2021-05-06 11:57   ` Mike Rapoport
2021-05-06 14:17 ` Theodore Ts'o [this message]
2021-05-06 14:17   ` Theodore Ts'o
2021-06-25 19:27   ` Constantine Shulyupin
2021-06-25 19:27     ` Constantine Shulyupin

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=YJP6bH/RXxcd/0Xf@mit.edu \
    --to=tytso@mit.edu \
    --cc=Gustavo.Pimentel@synopsys.com \
    --cc=James.Bottomley@hansenpartnership.com \
    --cc=Jonathan.Cameron@huawei.com \
    --cc=aaptel@suse.com \
    --cc=aisheng.dong@nxp.com \
    --cc=alex.williamson@redhat.com \
    --cc=alexandru.elisei@arm.com \
    --cc=andreyknvl@google.com \
    --cc=anshuman.khandual@arm.com \
    --cc=aquini@redhat.com \
    --cc=arnd@arndb.de \
    --cc=ast@kernel.org \
    --cc=axboe@kernel.dk \
    --cc=bernard@vivo.com \
    --cc=bobwxc@email.cn \
    --cc=bp@alien8.de \
    --cc=brijesh.singh@amd.com \
    --cc=broonie@kernel.org \
    --cc=catalin.marinas@arm.com \
    --cc=chris.packham@alliedtelesis.co.nz \
    --cc=constantine.shulyupin@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cw00.choi@samsung.com \
    --cc=daniel@iogearbox.net \
    --cc=davem@davemloft.net \
    --cc=davidgow@google.com \
    --cc=dhowells@redhat.com \
    --cc=dikshita@codeaurora.org \
    --cc=dlatypov@google.com \
    --cc=eesposit@redhat.com \
    --cc=eric.auger@redhat.com \
    --cc=erik.rosen@metormote.com \
    --cc=erik@flodin.me \
    --cc=federico.vaga@vaga.pv.it \
    --cc=festevam@gmail.com \
    --cc=georgi.djakov@linaro.org \
    --cc=gi-oh.kim@cloud.ionos.com \
    --cc=gi-oh.kim@ionos.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=haren@linux.ibm.com \
    --cc=hca@linux.ibm.com \
    --cc=hch@lst.de \
    --cc=hdegoede@redhat.com \
    --cc=heikki.krogerus@linux.intel.com \
    --cc=hengqi.chen@gmail.com \
    --cc=hverkuil-cisco@xs4all.nl \
    --cc=i@zenithal.me \
    --cc=jaegeuk@kernel.org \
    --cc=jamorris@linux.microsoft.com \
    --cc=jarkko@kernel.org \
    --cc=jgg@nvidia.com \
    --cc=jianyong.wu@arm.com \
    --cc=jonas@protocubo.io \
    --cc=kabel@kernel.org \
    --cc=keescook@chromium.org \
    --cc=kernelnewbies@kernelnewbies.org \
    --cc=kuba@kernel.org \
    --cc=kubernat@cesnet.cz \
    --cc=linus.walleij@linaro.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=linux@rasmusvillemoes.dk \
    --cc=linux@roeck-us.net \
    --cc=luzmaximilian@gmail.com \
    --cc=macro@orcam.me.uk \
    --cc=marcan@marcan.st \
    --cc=masahiroy@kernel.org \
    --cc=mathieu.poirier@linaro.org \
    --cc=maz@kernel.org \
    --cc=mchehab+huawei@kernel.org \
    --cc=mic@linux.microsoft.com \
    --cc=mkl@pengutronix.de \
    --cc=mpe@ellerman.id.au \
    --cc=mszeredi@redhat.com \
    --cc=natet@google.com \
    --cc=nicolas.dichtel@6wind.com \
    --cc=niklas.soderlund+renesas@ragnatech.se \
    --cc=npiggin@gmail.com \
    --cc=ogabbay@kernel.org \
    --cc=parav@nvidia.com \
    --cc=pbonzini@redhat.com \
    --cc=pcc@google.com \
    --cc=peterz@infradead.org \
    --cc=pmladek@suse.com \
    --cc=rafael.j.wysocki@intel.com \
    --cc=rppt@linux.ibm.com \
    --cc=saeedm@nvidia.com \
    --cc=sakari.ailus@linux.intel.com \
    --cc=sbhat@linux.ibm.com \
    --cc=schnelle@linux.ibm.com \
    --cc=sean.j.christopherson@intel.com \
    --cc=sebastian.reichel@collabora.com \
    --cc=shy828301@gmail.com \
    --cc=siyanteng@loongson.cn \
    --cc=skhan@linuxfoundation.org \
    --cc=sozeri@habana.ai \
    --cc=srutherford@google.com \
    --cc=stanimir.varbanov@linaro.org \
    --cc=stephane.blondon@gmail.com \
    --cc=stern@rowland.harvard.edu \
    --cc=stfrench@microsoft.com \
    --cc=sumit.garg@linaro.org \
    --cc=tamar.mashiah@intel.com \
    --cc=tglx@linutronix.de \
    --cc=tom.zanussi@linux.intel.com \
    --cc=torvalds@linux-foundation.org \
    --cc=unixbhaskar@gmail.com \
    --cc=vbabka@suse.cz \
    --cc=vincenzo.frascino@arm.com \
    --cc=vkoul@kernel.org \
    --cc=vladyslavt@nvidia.com \
    --cc=wilken.gottwalt@posteo.net \
    --cc=willy@infradead.org \
    --cc=yangbo.lu@nxp.com \
    --cc=yangtiezhu@loongson.cn \
    --cc=yuchao0@huawei.com \
    --cc=yuzenghui@huawei.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.