summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZachary Scott <zzakscott@gmail.com>2021-04-11 08:37:39 +0900
committerZachary Scott <zzakscott@gmail.com>2021-04-11 08:37:39 +0900
commitf60fba03bf86d5639ac3ad1e1c7dbd1e3407ae11 (patch)
tree54ffd9718a1b9127eb073a858d9e86d5ad819d47
parent4a6c7f8696f3a5df36fb752990f037b8ba9b5937 (diff)
Make sure to mention ext/Setup is optional
This step confused me when trying to compile Ruby after 5 years, so it should be avoided unless you need static linking.
-rw-r--r--README.md11
1 files changed, 6 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7cf05471a0..3cadbad851 100644
--- a/README.md
+++ b/README.md
@@ -92,12 +92,13 @@ in the mail body (not subject) to the address [ruby-talk-request@ruby-lang.org].
4. Edit `include/ruby/defines.h` if you need. Usually this step will not be needed.
-5. Remove comment mark(`#`) before the module names from `ext/Setup` (or add
- module names if not present), if you want to link modules statically.
+5. Optional: Remove comment mark(`#`) before the module names from `ext/Setup`.
- If you don't want to compile non static extension modules (probably on
- architectures which do not allow dynamic loading), remove comment mark
- from the line "`#option nodynamic`" in `ext/Setup`.
+ This step is only necessary if you want to link modules statically.
+
+ If you don't want to compile dynamic extensions (probably on architectures
+ which do not allow dynamic loading), remove comment mark from the line
+ "`#option nodynamic`" in `ext/Setup`.
Usually this step will not be needed.