aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoraglitke <aglitke@aglitke.localdomain>2006-09-07 09:17:59 -0500
committeraglitke <aglitke@aglitke.localdomain>2006-09-07 09:17:59 -0500
commitd48239bbcc878a024bda22a5b0c80eeee5340c85 (patch)
tree5b2be9ba7754e5a2a6cd24574e8d1605582b6952
parentf70a04643203ba49f157a7a6189a6159b1501c2b (diff)
downloadlibhugetlbfs-d48239bbcc878a024bda22a5b0c80eeee5340c85.tar.gz
docs: Clarify that we only support BDT and B link options
Signed-off-by: Steve Fox <drfickle@us.ibm.com>
-rw-r--r--HOWTO16
1 files changed, 12 insertions, 4 deletions
diff --git a/HOWTO b/HOWTO
index b4d7de6..5b4e820 100644
--- a/HOWTO
+++ b/HOWTO
@@ -221,14 +221,22 @@ specially link your application.
To link an application for hugepages, you should use the the
ld.hugetlbfs script included with libhugetlbfs in place of your normal
linker. Without any special options this will simply invoke GNU ld
-with the same parameters. To link a program for hugepages, one of the
-following options:
+with the same parameters.
+
+To link a program for hugepages, one of the following options should
+be specified:
+
--hugetlbfs-link=B
-Will link the application to store BSS data (only) into hugepages
+
+will link the application to store BSS data (only) into hugepages
+
--hugetlbfs-link=BDT
-Will link the application to store text, initialized data and BSS data
+
+will link the application to store text, initialized data and BSS data
into hugepages.
+These are the only supported linking options.
+
The ld.hugetlbfs script will invoke the system linker with all the
necessary options to link for hugepages, in particular selecting the
right linker script.