milos-linux/Documentation
Tobin C. Harding 9727a0144b doc: add maintainer book
There is currently very little documentation in the kernel on maintainer
level tasks. In particular there are no documents on creating pull
requests to submit to Linus.

Quoting Greg Kroah-Hartman on LKML:

    Anyway, this actually came up at the kernel summit / maintainer
    meeting a few weeks ago, in that "how do I make a
    good pull request to Linus" is something we need to document.

    Here's what I do, and it seems to work well, so maybe we should turn
    it into the start of the documentation for how to do it.

(quote references: kernel summit, Europe 2017)

Create a new kernel documentation book 'how to be a maintainer'
(suggested by Jonathan Corbet). Add chapters on 'configuring git' and
'creating a pull request'.

Most of the content was written by Linus Torvalds and Greg Kroah-Hartman
in discussion on LKML. This is stated at the start of one of the
chapters and the original email thread is referenced in
'pull-requests.rst'.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2017-12-11 14:43:24 -07:00
..
ABI platform-drivers-x86 for v4.15-1 2017-11-18 10:26:57 -08:00
accounting
acpi
admin-guide Documentation: mono: Update links and s/CVS/Git/ 2017-12-11 14:18:04 -07:00
aoe
arm
arm64 arm64 updates for 4.15 2017-11-15 10:56:56 -08:00
auxdisplay
backlight
blackfin
block block, bfq: move debug blkio stats behind CONFIG_DEBUG_BLK_CGROUP 2017-11-14 20:13:33 -07:00
blockdev
bpf
bus-devices
cdrom
cgroup-v1
cma
connector
console
core-api docs: refcount_t documentation 2017-12-11 14:37:11 -07:00
cpu-freq
cpuidle
cris
crypto
dev-tools Kbuild misc updates for v4.15 2017-11-17 17:51:33 -08:00
device-mapper
devicetree ARM: SoC fixes for 4.15-rc 2017-12-10 08:26:59 -08:00
doc-guide
driver-api docs: refcount_t documentation 2017-12-11 14:37:11 -07:00
driver-model We have two changes to the core framework this time around. The first being a 2017-11-17 20:04:24 -08:00
early-userspace
EDID
extcon
fault-injection
fb
features
filesystems Merge branch 'akpm' (patches from Andrew) 2017-11-17 16:56:17 -08:00
firmware_class
fmc
fpga
frv
gpio
gpu amdgpu DC display code for Vega. 2017-11-17 14:34:42 -08:00
hid
hwmon
i2c
ia64 kbuild: /bin/pwd -> pwd 2017-11-18 11:32:27 +09:00
ide
iio
infiniband
input
ioctl
isdn
kbuild DeviceTree for 4.15: 2017-11-14 18:25:40 -08:00
kdump
kernel-hacking Documentation: kernel-hacking: corrected a typo 2017-12-11 14:19:06 -07:00
laptops
leds
lightnvm
livepatch
locking
m68k
maintainer doc: add maintainer book 2017-12-11 14:43:24 -07:00
md
media media: docs: add documentation for frontend attach info 2017-11-30 04:19:04 -05:00
memory-devices
metag
mic
mips
misc-devices
mmc
mn10300
mtd
namespaces
netlabel
networking Merge git://git.kernel.org/pub/scm/linux/kernel/git/davem/net-next 2017-11-15 11:56:19 -08:00
nfc
nios2
nvdimm
nvmem
openrisc
parisc
PCI
pcmcia
perf
phy
platform
power PM / runtime: Drop children check from __pm_runtime_set_status() 2017-11-16 22:51:22 +01:00
powerpc
pps
process A few late-arriving docs updates that have no real reason to wait. There's 2017-11-23 21:01:32 -10:00
pti
ptp
rapidio
RCU
s390
scheduler sched/deadline: Fix the description of runtime accounting in the documentation 2017-11-16 09:00:35 +01:00
scsi scsi: documentation: Fix case of 'scsi_device' struct mention(s) 2017-12-02 08:43:43 -07:00
security KEYS: fix in-kernel documentation for keyctl_read() 2017-11-15 16:38:44 +00:00
serial
sh
sound sound updates for 4.15-rc1 2017-11-14 18:01:46 -08:00
sparc
sphinx
sphinx-static
spi
sysctl Revert "mm/page-writeback.c: print a warning if the vm dirtiness settings are illogical" 2017-11-29 18:40:43 -08:00
target
thermal
timers
trace Char/Misc patches for 4.15-rc1 2017-11-16 09:10:59 -08:00
translations A few late-arriving docs updates that have no real reason to wait. There's 2017-11-23 21:01:32 -10:00
usb
userspace-api
virtual KVM: s390: mark irq_state.flags as non-usable 2017-12-06 09:18:43 +01:00
vm mm/mmu_notifier: avoid double notification when it is useless 2017-11-15 18:21:03 -08:00
w1
watchdog
wimax
x86 x86/pkeys: Update documentation about availability 2017-11-21 09:34:52 +01:00
xtensa
.gitignore
00-INDEX
atomic_bitops.txt
atomic_t.txt
bcache.txt
bt8xxgpio.txt
btmrvl.txt
bus-virt-phys-mapping.txt
cachetlb.txt
cgroup-v2.txt
Changes
circular-buffers.txt
clearing-warn-once.txt kernel debug: support resetting WARN*_ONCE 2017-11-17 16:10:00 -08:00
clk.txt
CodingStyle
conf.py
cpu-load.txt
cputopology.txt
crc32.txt
dcdbas.txt
debugging-modules.txt
debugging-via-ohci1394.txt
dell_rbu.txt
digsig.txt
DMA-API-HOWTO.txt
DMA-API.txt
DMA-attributes.txt
DMA-ISA-LPC.txt
docutils.conf
dontdiff
efi-stub.txt
eisa.txt
errseq.rst
flexible-arrays.txt
futex-requeue-pi.txt
gcc-plugins.txt
highuid.txt
hw_random.txt
hwspinlock.txt
index.rst doc: add maintainer book 2017-12-11 14:43:24 -07:00
Intel-IOMMU.txt
intel_txt.txt
io-mapping.txt
io_ordering.txt
iostats.txt
IPMI.txt
IRQ-affinity.txt
IRQ-domain.txt
IRQ.txt
irqflags-tracing.txt
isa.txt
isapnp.txt
kernel-doc-nano-HOWTO.txt
kernel-per-CPU-kthreads.txt
kobject.txt
kprobes.txt
kref.txt
ldm.txt
lockup-watchdogs.txt
logo.gif
logo.txt
lsm.txt
lzo.txt
mailbox.txt
Makefile
memory-barriers.txt
memory-hotplug.txt
men-chameleon-bus.txt
nommu-mmap.txt
ntb.txt
numastat.txt
padata.txt
parport-lowlevel.txt
percpu-rw-semaphore.txt
phy.txt
pi-futex.txt
pnp.txt
preempt-locking.txt
printk-formats.txt vsprintf: add printk specifier %px 2017-11-29 12:13:14 +11:00
pwm.txt
rbtree.txt
remoteproc.txt
rfkill.txt
robust-futex-ABI.txt
robust-futexes.txt
rpmsg.txt
rtc.txt
SAK.txt
sgi-ioc4.txt
siphash.txt
SM501.txt
smsc_ece1099.txt
static-keys.txt
SubmittingPatches
svga.txt documentation/svga.txt: update outdated file 2017-11-20 10:45:50 -07:00
switchtec.txt NTB: switchtec_ntb: Update switchtec documentation with notes for NTB 2017-11-18 20:37:13 -05:00
sync_file.txt
tee.txt
this_cpu_ops.txt
unaligned-memory-access.txt
vfio-mediated-device.txt
vfio.txt
video-output.txt
xillybus.txt
xz.txt
zorro.txt