Commit 2008713c7174e5c0f207bac684c6df0939047009

Authored by H. Peter Anvin
Committed by Linus Torvalds
1 parent 6bb1e3819c

Makefile: Documentation for external tool should be correct

If one includes documentation for an external tool, it should be
correct.  This is not:

1. Overriding the input to rngd should typically be neither
   necessary nor desired.  This is especially so since newer
   versions of rngd support a number of different *types* of sources.
2. The default kernel-exported device is called /dev/hwrng not
   /dev/hwrandom nor /dev/hw_random (both of which were used in the
   past; however, kernel and udev seem to have converged on
   /dev/hwrng.)

Overall it is better if the documentation for rngd is kept with rngd
rather than in a kernel Makefile.

Signed-off-by: H. Peter Anvin <hpa@linux.intel.com>
Cc: David Howells <dhowells@redhat.com>
Cc: Jeff Garzik <jgarzik@redhat.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 1 changed file with 2 additions and 4 deletions Inline Diff

1 # 1 #
2 # Makefile for the linux kernel. 2 # Makefile for the linux kernel.
3 # 3 #
4 4
5 obj-y = fork.o exec_domain.o panic.o printk.o \ 5 obj-y = fork.o exec_domain.o panic.o printk.o \
6 cpu.o exit.o itimer.o time.o softirq.o resource.o \ 6 cpu.o exit.o itimer.o time.o softirq.o resource.o \
7 sysctl.o sysctl_binary.o capability.o ptrace.o timer.o user.o \ 7 sysctl.o sysctl_binary.o capability.o ptrace.o timer.o user.o \
8 signal.o sys.o kmod.o workqueue.o pid.o task_work.o \ 8 signal.o sys.o kmod.o workqueue.o pid.o task_work.o \
9 rcupdate.o extable.o params.o posix-timers.o \ 9 rcupdate.o extable.o params.o posix-timers.o \
10 kthread.o wait.o kfifo.o sys_ni.o posix-cpu-timers.o mutex.o \ 10 kthread.o wait.o kfifo.o sys_ni.o posix-cpu-timers.o mutex.o \
11 hrtimer.o rwsem.o nsproxy.o srcu.o semaphore.o \ 11 hrtimer.o rwsem.o nsproxy.o srcu.o semaphore.o \
12 notifier.o ksysfs.o cred.o \ 12 notifier.o ksysfs.o cred.o \
13 async.o range.o groups.o lglock.o smpboot.o 13 async.o range.o groups.o lglock.o smpboot.o
14 14
15 ifdef CONFIG_FUNCTION_TRACER 15 ifdef CONFIG_FUNCTION_TRACER
16 # Do not trace debug files and internal ftrace files 16 # Do not trace debug files and internal ftrace files
17 CFLAGS_REMOVE_lockdep.o = -pg 17 CFLAGS_REMOVE_lockdep.o = -pg
18 CFLAGS_REMOVE_lockdep_proc.o = -pg 18 CFLAGS_REMOVE_lockdep_proc.o = -pg
19 CFLAGS_REMOVE_mutex-debug.o = -pg 19 CFLAGS_REMOVE_mutex-debug.o = -pg
20 CFLAGS_REMOVE_rtmutex-debug.o = -pg 20 CFLAGS_REMOVE_rtmutex-debug.o = -pg
21 CFLAGS_REMOVE_cgroup-debug.o = -pg 21 CFLAGS_REMOVE_cgroup-debug.o = -pg
22 CFLAGS_REMOVE_irq_work.o = -pg 22 CFLAGS_REMOVE_irq_work.o = -pg
23 endif 23 endif
24 24
25 obj-y += sched/ 25 obj-y += sched/
26 obj-y += power/ 26 obj-y += power/
27 27
28 ifeq ($(CONFIG_CHECKPOINT_RESTORE),y) 28 ifeq ($(CONFIG_CHECKPOINT_RESTORE),y)
29 obj-$(CONFIG_X86) += kcmp.o 29 obj-$(CONFIG_X86) += kcmp.o
30 endif 30 endif
31 obj-$(CONFIG_FREEZER) += freezer.o 31 obj-$(CONFIG_FREEZER) += freezer.o
32 obj-$(CONFIG_PROFILING) += profile.o 32 obj-$(CONFIG_PROFILING) += profile.o
33 obj-$(CONFIG_STACKTRACE) += stacktrace.o 33 obj-$(CONFIG_STACKTRACE) += stacktrace.o
34 obj-y += time/ 34 obj-y += time/
35 obj-$(CONFIG_DEBUG_MUTEXES) += mutex-debug.o 35 obj-$(CONFIG_DEBUG_MUTEXES) += mutex-debug.o
36 obj-$(CONFIG_LOCKDEP) += lockdep.o 36 obj-$(CONFIG_LOCKDEP) += lockdep.o
37 ifeq ($(CONFIG_PROC_FS),y) 37 ifeq ($(CONFIG_PROC_FS),y)
38 obj-$(CONFIG_LOCKDEP) += lockdep_proc.o 38 obj-$(CONFIG_LOCKDEP) += lockdep_proc.o
39 endif 39 endif
40 obj-$(CONFIG_FUTEX) += futex.o 40 obj-$(CONFIG_FUTEX) += futex.o
41 ifeq ($(CONFIG_COMPAT),y) 41 ifeq ($(CONFIG_COMPAT),y)
42 obj-$(CONFIG_FUTEX) += futex_compat.o 42 obj-$(CONFIG_FUTEX) += futex_compat.o
43 endif 43 endif
44 obj-$(CONFIG_RT_MUTEXES) += rtmutex.o 44 obj-$(CONFIG_RT_MUTEXES) += rtmutex.o
45 obj-$(CONFIG_DEBUG_RT_MUTEXES) += rtmutex-debug.o 45 obj-$(CONFIG_DEBUG_RT_MUTEXES) += rtmutex-debug.o
46 obj-$(CONFIG_RT_MUTEX_TESTER) += rtmutex-tester.o 46 obj-$(CONFIG_RT_MUTEX_TESTER) += rtmutex-tester.o
47 obj-$(CONFIG_GENERIC_ISA_DMA) += dma.o 47 obj-$(CONFIG_GENERIC_ISA_DMA) += dma.o
48 obj-$(CONFIG_SMP) += smp.o 48 obj-$(CONFIG_SMP) += smp.o
49 ifneq ($(CONFIG_SMP),y) 49 ifneq ($(CONFIG_SMP),y)
50 obj-y += up.o 50 obj-y += up.o
51 endif 51 endif
52 obj-$(CONFIG_SMP) += spinlock.o 52 obj-$(CONFIG_SMP) += spinlock.o
53 obj-$(CONFIG_DEBUG_SPINLOCK) += spinlock.o 53 obj-$(CONFIG_DEBUG_SPINLOCK) += spinlock.o
54 obj-$(CONFIG_PROVE_LOCKING) += spinlock.o 54 obj-$(CONFIG_PROVE_LOCKING) += spinlock.o
55 obj-$(CONFIG_UID16) += uid16.o 55 obj-$(CONFIG_UID16) += uid16.o
56 obj-$(CONFIG_MODULES) += module.o 56 obj-$(CONFIG_MODULES) += module.o
57 obj-$(CONFIG_MODULE_SIG) += module_signing.o modsign_pubkey.o 57 obj-$(CONFIG_MODULE_SIG) += module_signing.o modsign_pubkey.o
58 obj-$(CONFIG_KALLSYMS) += kallsyms.o 58 obj-$(CONFIG_KALLSYMS) += kallsyms.o
59 obj-$(CONFIG_BSD_PROCESS_ACCT) += acct.o 59 obj-$(CONFIG_BSD_PROCESS_ACCT) += acct.o
60 obj-$(CONFIG_KEXEC) += kexec.o 60 obj-$(CONFIG_KEXEC) += kexec.o
61 obj-$(CONFIG_BACKTRACE_SELF_TEST) += backtracetest.o 61 obj-$(CONFIG_BACKTRACE_SELF_TEST) += backtracetest.o
62 obj-$(CONFIG_COMPAT) += compat.o 62 obj-$(CONFIG_COMPAT) += compat.o
63 obj-$(CONFIG_CGROUPS) += cgroup.o 63 obj-$(CONFIG_CGROUPS) += cgroup.o
64 obj-$(CONFIG_CGROUP_FREEZER) += cgroup_freezer.o 64 obj-$(CONFIG_CGROUP_FREEZER) += cgroup_freezer.o
65 obj-$(CONFIG_CPUSETS) += cpuset.o 65 obj-$(CONFIG_CPUSETS) += cpuset.o
66 obj-$(CONFIG_UTS_NS) += utsname.o 66 obj-$(CONFIG_UTS_NS) += utsname.o
67 obj-$(CONFIG_USER_NS) += user_namespace.o 67 obj-$(CONFIG_USER_NS) += user_namespace.o
68 obj-$(CONFIG_PID_NS) += pid_namespace.o 68 obj-$(CONFIG_PID_NS) += pid_namespace.o
69 obj-$(CONFIG_IKCONFIG) += configs.o 69 obj-$(CONFIG_IKCONFIG) += configs.o
70 obj-$(CONFIG_RESOURCE_COUNTERS) += res_counter.o 70 obj-$(CONFIG_RESOURCE_COUNTERS) += res_counter.o
71 obj-$(CONFIG_SMP) += stop_machine.o 71 obj-$(CONFIG_SMP) += stop_machine.o
72 obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o 72 obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o
73 obj-$(CONFIG_AUDIT) += audit.o auditfilter.o 73 obj-$(CONFIG_AUDIT) += audit.o auditfilter.o
74 obj-$(CONFIG_AUDITSYSCALL) += auditsc.o 74 obj-$(CONFIG_AUDITSYSCALL) += auditsc.o
75 obj-$(CONFIG_AUDIT_WATCH) += audit_watch.o 75 obj-$(CONFIG_AUDIT_WATCH) += audit_watch.o
76 obj-$(CONFIG_AUDIT_TREE) += audit_tree.o 76 obj-$(CONFIG_AUDIT_TREE) += audit_tree.o
77 obj-$(CONFIG_GCOV_KERNEL) += gcov/ 77 obj-$(CONFIG_GCOV_KERNEL) += gcov/
78 obj-$(CONFIG_KPROBES) += kprobes.o 78 obj-$(CONFIG_KPROBES) += kprobes.o
79 obj-$(CONFIG_KGDB) += debug/ 79 obj-$(CONFIG_KGDB) += debug/
80 obj-$(CONFIG_DETECT_HUNG_TASK) += hung_task.o 80 obj-$(CONFIG_DETECT_HUNG_TASK) += hung_task.o
81 obj-$(CONFIG_LOCKUP_DETECTOR) += watchdog.o 81 obj-$(CONFIG_LOCKUP_DETECTOR) += watchdog.o
82 obj-$(CONFIG_GENERIC_HARDIRQS) += irq/ 82 obj-$(CONFIG_GENERIC_HARDIRQS) += irq/
83 obj-$(CONFIG_SECCOMP) += seccomp.o 83 obj-$(CONFIG_SECCOMP) += seccomp.o
84 obj-$(CONFIG_RCU_TORTURE_TEST) += rcutorture.o 84 obj-$(CONFIG_RCU_TORTURE_TEST) += rcutorture.o
85 obj-$(CONFIG_TREE_RCU) += rcutree.o 85 obj-$(CONFIG_TREE_RCU) += rcutree.o
86 obj-$(CONFIG_TREE_PREEMPT_RCU) += rcutree.o 86 obj-$(CONFIG_TREE_PREEMPT_RCU) += rcutree.o
87 obj-$(CONFIG_TREE_RCU_TRACE) += rcutree_trace.o 87 obj-$(CONFIG_TREE_RCU_TRACE) += rcutree_trace.o
88 obj-$(CONFIG_TINY_RCU) += rcutiny.o 88 obj-$(CONFIG_TINY_RCU) += rcutiny.o
89 obj-$(CONFIG_TINY_PREEMPT_RCU) += rcutiny.o 89 obj-$(CONFIG_TINY_PREEMPT_RCU) += rcutiny.o
90 obj-$(CONFIG_RELAY) += relay.o 90 obj-$(CONFIG_RELAY) += relay.o
91 obj-$(CONFIG_SYSCTL) += utsname_sysctl.o 91 obj-$(CONFIG_SYSCTL) += utsname_sysctl.o
92 obj-$(CONFIG_TASK_DELAY_ACCT) += delayacct.o 92 obj-$(CONFIG_TASK_DELAY_ACCT) += delayacct.o
93 obj-$(CONFIG_TASKSTATS) += taskstats.o tsacct.o 93 obj-$(CONFIG_TASKSTATS) += taskstats.o tsacct.o
94 obj-$(CONFIG_TRACEPOINTS) += tracepoint.o 94 obj-$(CONFIG_TRACEPOINTS) += tracepoint.o
95 obj-$(CONFIG_LATENCYTOP) += latencytop.o 95 obj-$(CONFIG_LATENCYTOP) += latencytop.o
96 obj-$(CONFIG_BINFMT_ELF) += elfcore.o 96 obj-$(CONFIG_BINFMT_ELF) += elfcore.o
97 obj-$(CONFIG_COMPAT_BINFMT_ELF) += elfcore.o 97 obj-$(CONFIG_COMPAT_BINFMT_ELF) += elfcore.o
98 obj-$(CONFIG_BINFMT_ELF_FDPIC) += elfcore.o 98 obj-$(CONFIG_BINFMT_ELF_FDPIC) += elfcore.o
99 obj-$(CONFIG_FUNCTION_TRACER) += trace/ 99 obj-$(CONFIG_FUNCTION_TRACER) += trace/
100 obj-$(CONFIG_TRACING) += trace/ 100 obj-$(CONFIG_TRACING) += trace/
101 obj-$(CONFIG_TRACE_CLOCK) += trace/ 101 obj-$(CONFIG_TRACE_CLOCK) += trace/
102 obj-$(CONFIG_RING_BUFFER) += trace/ 102 obj-$(CONFIG_RING_BUFFER) += trace/
103 obj-$(CONFIG_TRACEPOINTS) += trace/ 103 obj-$(CONFIG_TRACEPOINTS) += trace/
104 obj-$(CONFIG_IRQ_WORK) += irq_work.o 104 obj-$(CONFIG_IRQ_WORK) += irq_work.o
105 obj-$(CONFIG_CPU_PM) += cpu_pm.o 105 obj-$(CONFIG_CPU_PM) += cpu_pm.o
106 106
107 obj-$(CONFIG_PERF_EVENTS) += events/ 107 obj-$(CONFIG_PERF_EVENTS) += events/
108 108
109 obj-$(CONFIG_USER_RETURN_NOTIFIER) += user-return-notifier.o 109 obj-$(CONFIG_USER_RETURN_NOTIFIER) += user-return-notifier.o
110 obj-$(CONFIG_PADATA) += padata.o 110 obj-$(CONFIG_PADATA) += padata.o
111 obj-$(CONFIG_CRASH_DUMP) += crash_dump.o 111 obj-$(CONFIG_CRASH_DUMP) += crash_dump.o
112 obj-$(CONFIG_JUMP_LABEL) += jump_label.o 112 obj-$(CONFIG_JUMP_LABEL) += jump_label.o
113 113
114 $(obj)/configs.o: $(obj)/config_data.h 114 $(obj)/configs.o: $(obj)/config_data.h
115 115
116 # config_data.h contains the same information as ikconfig.h but gzipped. 116 # config_data.h contains the same information as ikconfig.h but gzipped.
117 # Info from config_data can be extracted from /proc/config* 117 # Info from config_data can be extracted from /proc/config*
118 targets += config_data.gz 118 targets += config_data.gz
119 $(obj)/config_data.gz: $(KCONFIG_CONFIG) FORCE 119 $(obj)/config_data.gz: $(KCONFIG_CONFIG) FORCE
120 $(call if_changed,gzip) 120 $(call if_changed,gzip)
121 121
122 filechk_ikconfiggz = (echo "static const char kernel_config_data[] __used = MAGIC_START"; cat $< | scripts/bin2c; echo "MAGIC_END;") 122 filechk_ikconfiggz = (echo "static const char kernel_config_data[] __used = MAGIC_START"; cat $< | scripts/bin2c; echo "MAGIC_END;")
123 targets += config_data.h 123 targets += config_data.h
124 $(obj)/config_data.h: $(obj)/config_data.gz FORCE 124 $(obj)/config_data.h: $(obj)/config_data.gz FORCE
125 $(call filechk,ikconfiggz) 125 $(call filechk,ikconfiggz)
126 126
127 $(obj)/time.o: $(obj)/timeconst.h 127 $(obj)/time.o: $(obj)/timeconst.h
128 128
129 quiet_cmd_timeconst = TIMEC $@ 129 quiet_cmd_timeconst = TIMEC $@
130 cmd_timeconst = $(PERL) $< $(CONFIG_HZ) > $@ 130 cmd_timeconst = $(PERL) $< $(CONFIG_HZ) > $@
131 targets += timeconst.h 131 targets += timeconst.h
132 $(obj)/timeconst.h: $(src)/timeconst.pl FORCE 132 $(obj)/timeconst.h: $(src)/timeconst.pl FORCE
133 $(call if_changed,timeconst) 133 $(call if_changed,timeconst)
134 134
135 ifeq ($(CONFIG_MODULE_SIG),y) 135 ifeq ($(CONFIG_MODULE_SIG),y)
136 # 136 #
137 # Pull the signing certificate and any extra certificates into the kernel 137 # Pull the signing certificate and any extra certificates into the kernel
138 # 138 #
139 extra_certificates: 139 extra_certificates:
140 touch $@ 140 touch $@
141 141
142 kernel/modsign_pubkey.o: signing_key.x509 extra_certificates 142 kernel/modsign_pubkey.o: signing_key.x509 extra_certificates
143 143
144 ############################################################################### 144 ###############################################################################
145 # 145 #
146 # If module signing is requested, say by allyesconfig, but a key has not been 146 # If module signing is requested, say by allyesconfig, but a key has not been
147 # supplied, then one will need to be generated to make sure the build does not 147 # supplied, then one will need to be generated to make sure the build does not
148 # fail and that the kernel may be used afterwards. 148 # fail and that the kernel may be used afterwards.
149 # 149 #
150 ############################################################################### 150 ###############################################################################
151 sign_key_with_hash := 151 sign_key_with_hash :=
152 ifeq ($(CONFIG_MODULE_SIG_SHA1),y) 152 ifeq ($(CONFIG_MODULE_SIG_SHA1),y)
153 sign_key_with_hash := -sha1 153 sign_key_with_hash := -sha1
154 endif 154 endif
155 ifeq ($(CONFIG_MODULE_SIG_SHA224),y) 155 ifeq ($(CONFIG_MODULE_SIG_SHA224),y)
156 sign_key_with_hash := -sha224 156 sign_key_with_hash := -sha224
157 endif 157 endif
158 ifeq ($(CONFIG_MODULE_SIG_SHA256),y) 158 ifeq ($(CONFIG_MODULE_SIG_SHA256),y)
159 sign_key_with_hash := -sha256 159 sign_key_with_hash := -sha256
160 endif 160 endif
161 ifeq ($(CONFIG_MODULE_SIG_SHA384),y) 161 ifeq ($(CONFIG_MODULE_SIG_SHA384),y)
162 sign_key_with_hash := -sha384 162 sign_key_with_hash := -sha384
163 endif 163 endif
164 ifeq ($(CONFIG_MODULE_SIG_SHA512),y) 164 ifeq ($(CONFIG_MODULE_SIG_SHA512),y)
165 sign_key_with_hash := -sha512 165 sign_key_with_hash := -sha512
166 endif 166 endif
167 ifeq ($(sign_key_with_hash),) 167 ifeq ($(sign_key_with_hash),)
168 $(error Could not determine digest type to use from kernel config) 168 $(error Could not determine digest type to use from kernel config)
169 endif 169 endif
170 170
171 signing_key.priv signing_key.x509: x509.genkey 171 signing_key.priv signing_key.x509: x509.genkey
172 @echo "###" 172 @echo "###"
173 @echo "### Now generating an X.509 key pair to be used for signing modules." 173 @echo "### Now generating an X.509 key pair to be used for signing modules."
174 @echo "###" 174 @echo "###"
175 @echo "### If this takes a long time, you might wish to run rngd in the" 175 @echo "### If this takes a long time, you might wish to run rngd in the"
176 @echo "### background to keep the supply of entropy topped up. It" 176 @echo "### background to keep the supply of entropy topped up. It"
177 @echo "### needs to be run as root, and should use a hardware random" 177 @echo "### needs to be run as root, and uses a hardware random"
178 @echo "### number generator if one is available, eg:" 178 @echo "### number generator if one is available."
179 @echo "###"
180 @echo "### rngd -r /dev/hwrandom"
181 @echo "###" 179 @echo "###"
182 openssl req -new -nodes -utf8 $(sign_key_with_hash) -days 36500 -batch \ 180 openssl req -new -nodes -utf8 $(sign_key_with_hash) -days 36500 -batch \
183 -x509 -config x509.genkey \ 181 -x509 -config x509.genkey \
184 -outform DER -out signing_key.x509 \ 182 -outform DER -out signing_key.x509 \
185 -keyout signing_key.priv 183 -keyout signing_key.priv
186 @echo "###" 184 @echo "###"
187 @echo "### Key pair generated." 185 @echo "### Key pair generated."
188 @echo "###" 186 @echo "###"
189 187
190 x509.genkey: 188 x509.genkey:
191 @echo Generating X.509 key generation config 189 @echo Generating X.509 key generation config
192 @echo >x509.genkey "[ req ]" 190 @echo >x509.genkey "[ req ]"
193 @echo >>x509.genkey "default_bits = 4096" 191 @echo >>x509.genkey "default_bits = 4096"
194 @echo >>x509.genkey "distinguished_name = req_distinguished_name" 192 @echo >>x509.genkey "distinguished_name = req_distinguished_name"
195 @echo >>x509.genkey "prompt = no" 193 @echo >>x509.genkey "prompt = no"
196 @echo >>x509.genkey "string_mask = utf8only" 194 @echo >>x509.genkey "string_mask = utf8only"
197 @echo >>x509.genkey "x509_extensions = myexts" 195 @echo >>x509.genkey "x509_extensions = myexts"
198 @echo >>x509.genkey 196 @echo >>x509.genkey
199 @echo >>x509.genkey "[ req_distinguished_name ]" 197 @echo >>x509.genkey "[ req_distinguished_name ]"
200 @echo >>x509.genkey "O = Magrathea" 198 @echo >>x509.genkey "O = Magrathea"
201 @echo >>x509.genkey "CN = Glacier signing key" 199 @echo >>x509.genkey "CN = Glacier signing key"
202 @echo >>x509.genkey "emailAddress = slartibartfast@magrathea.h2g2" 200 @echo >>x509.genkey "emailAddress = slartibartfast@magrathea.h2g2"
203 @echo >>x509.genkey 201 @echo >>x509.genkey
204 @echo >>x509.genkey "[ myexts ]" 202 @echo >>x509.genkey "[ myexts ]"
205 @echo >>x509.genkey "basicConstraints=critical,CA:FALSE" 203 @echo >>x509.genkey "basicConstraints=critical,CA:FALSE"
206 @echo >>x509.genkey "keyUsage=digitalSignature" 204 @echo >>x509.genkey "keyUsage=digitalSignature"
207 @echo >>x509.genkey "subjectKeyIdentifier=hash" 205 @echo >>x509.genkey "subjectKeyIdentifier=hash"
208 @echo >>x509.genkey "authorityKeyIdentifier=keyid" 206 @echo >>x509.genkey "authorityKeyIdentifier=keyid"
209 endif 207 endif
210 208