Merge pull request #1827 from wilzbach/fix-17649

Fix Issue 17649 - CONTRIBUTING.md instructions failed (no ../druntime…

Author: wilzbach

CONTRIBUTING.md

@@ -11,36 +11,34 @@ Make sure you have these prerequisites working:
 * The C++ compiler for your platform (invokable as `gcc`)
 * Optional: `latex` for building the pdf documentation
 * Optional: `kindlegen` for building the Kindle documentation
-* If you're running OSX, make sure you have some version of `libevent` installed
+* If you're running OSX, make sure you have some version of `libevent` installed (needed for Ddox)
 
 ## Getting the code
 
-Create a working directory for the D language, e.g. `~/code/d`. The remainder
-of this document calls that directory henceforth `$R` from "Root". To get the
-code:
+If you already have a [working directory for the D language](https://wiki.dlang.org/Building_under_Posix#Fetch_repositories_from_GitHub),
+e.g. `~/dlang`, change to it.
+
+To get the code, run:
 
 ```
-cd $R
 git clone https://github.com/dlang/dlang.org
-git clone https://github.com/dlang/dmd
+cd dlang.org
 ```
 
-The `dmd` compiler is needed for processing the documentation.
+The remainder of this document assumes that is your current working directory.
 
 ## Building the main site
 
-Now in `$R` there are two directories called `dmd` and `dlang.org`. To
-build the main site, run this:
+To build the main site, run:
 
 ```
-cd $R/dlang.org
 make -f posix.mak html
 ```
 
 This builds the `dmd` compiler itself first and then uses it to build the
 website pages. You may see warnings while the compiler is built. After `make`
-ended with error code 0, directory `$R/dlang.org/web` contains the produced HTML
-files. Take a moment to open `$R/dlang.org/web/index.html` in a browser.
+ended with error code 0, directory `web` contains the produced HTML
+files. Take a moment to open `web/index.html` in a browser.
 
 ## Building the standard library documentation
 
@@ -54,48 +52,47 @@ currently being worked on. The "release" version is built with the "release"
 compiler, and the current version is built with the current compiler (which we
 already have from the previous step).
 
-### Building the release libraries
+### Building the `prerelease` libraries
 
-Fortunately there's no need to fumble with version numbers and git tags etc.;
-all is automated. Run this command:
+The more interesting stuff to build is the prerelease libraries because in all
+likelihood that's what needs looking at and testing.
 
 ```
-cd $R/dlang.org
-make -f posix.mak druntime-release
-make -f posix.mak phobos-release
-make -f posix.mak apidocs-release
+make -f posix.mak docs-prerelease
 ```
 
-These commands tell you the release being built in their first line of output.
-Then they proceed and clone the appropriate release for `dmd`, `druntime`, and
-`phobos`. After all commands have been executed, the following directories will
-be present in `$R`: `dlang.org`, `dmd`, `dmd-2.083.2`, `druntime-2.083.2`, and
-`phobos-2.083.2`. Note that the actual release number may not be `2.083.2`, but
-should be the same for all three directories.
+If you only want to build a specific part (e.g. Phobos), run:
 
-The output is in `$R/dlang.org/web/phobos` and `$R/dlang.org/web/library`.
+```
+make -f posix.mak phobos-prerelease
+```
 
-### Building the prerelease libraries
+(`docs-prerelease` is a shorthand for `dmd-prerelease`, `druntime-prerelease`, `phobos-releas` and `apidocs-prerelease`)
 
-The more interesting stuff to build is the prerelease libraries because in all
-likelihood that's what needs looking at and testing. To do that two more
-repositories containing the core and standard libraries are needed: `druntime`
-and `phobos`:
+The output is in `web/phobos-prerelease` and `library-prerelease`.
+
+### Building the `release` libraries
+
+Fortunately there's no need to fumble with version numbers and git tags etc.;
+all is automated. Run this command:
 
 ```
-cd $R
-git clone https://github.com/dlang/druntime
-git clone https://github.com/dlang/phobos
+make -f posix.mak docs-release
 ```
 
-With the new repos in tow this builds the prerelease libraries:
+If you only want to build a specific part (e.g. Phobos), run:
 
 ```
-cd $R/dlang.org
-make -f posix.mak druntime-prerelease
-make -f posix.mak phobos-prerelease
-make -f posix.mak apidocs-prerelease
+make -f posix.mak phobos-release
 ```
 
-The output is in `$R/dlang.org/web/phobos-prerelease` and
-`$R/dlang.org/web/library-prerelease`.
+(`docs-release` is a shorthand for `dmd-release`, `druntime-release`, `phobos-releas` and `apidocs-release`)
+
+These commands tell you the release being built in their first line of output.
+Then they proceed and clone the appropriate release for `dmd`, `druntime`, and
+`phobos`. After all commands have been executed, the following directories will
+be present in `$R`: `dlang.org`, `dmd`, `dmd-2.083.2`, `druntime-2.083.2`, and
+`phobos-2.083.2`. Note that the actual release number may not be `2.083.2`, but
+should be the same for all three directories.
+
+The output is in `web/phobos` and `web/library`.

posix.mak

@@ -44,6 +44,10 @@ DMD_STABLE=$(DMD_STABLE_DIR)/generated/$(OS)/release/$(MODEL)/dmd
 DRUNTIME_STABLE_DIR=${DRUNTIME_DIR}-${LATEST}
 PHOBOS_STABLE_DIR=${PHOBOS_DIR}-${LATEST}
 
+# Auto-cloning missing directories
+$(shell [ ! -d $(DMD_DIR) ] && git clone --depth=1 ${GIT_HOME}/dmd $(DMD_DIR))
+$(shell [ ! -d $(DRUNTIME_DIR) ] && git clone --depth=1 ${GIT_HOME}/druntime $(DRUNTIME_DIR))
+
 ################################################################################
 # Automatically generated directories
 GENERATED=.generated
@@ -230,8 +234,10 @@ ALL_FILES = $(ALL_FILES_BUT_SITEMAP) $(DOC_OUTPUT_DIR)/sitemap.html
 
 all : docs html
 
-docs : dmd-release dmd-prerelease phobos-prerelease druntime-prerelease \
-	   druntime-release phobos-release apidocs-release apidocs-prerelease
+docs-release: dmd-release druntime-release phobos-release apidocs-release
+docs-prerelease: dmd-prerelease druntime-prerelease phobos-prerelease apidocs-prerelease
+
+docs : docs-release docs-prerelease
 
 html : $(ALL_FILES)