Moved build docs to devdocs, fixes JuliaLang#35122. (JuliaLang#41313)

Co-authored-by: Arun <[email protected]>
Co-authored-by: Fredrik Ekre <[email protected]>

README.md

@@ -136,8 +136,7 @@ The Julia source code is organized as follows:
 | `cli/` | source for the command line interface/REPL |
 | `contrib/` | editor support for Julia source, miscellaneous scripts |
 | `deps/` | external dependencies |
-| `doc/src/manual/` | source for the user manual |
-| `doc/build/` | detailed notes for building Julia |
+| `doc/src/` | source for the user manual |
 | `src/` | source for Julia language core |
 | `test/` | test suites |
 | `usr/` | binaries and shared libraries loaded by Julia's standard libraries |

doc/make.jl

@@ -155,7 +155,16 @@ DevDocs = [
  "devdocs/debuggingtips.md",
  "devdocs/valgrind.md",
  "devdocs/sanitizers.md",
- "devdocs/probes.md"
+ "devdocs/probes.md",
+ ],
+ "Building Julia" => [
+ "devdocs/build/build.md",
+ "devdocs/build/linux.md",
+ "devdocs/build/macos.md",
+ "devdocs/build/windows.md",
+ "devdocs/build/freebsd.md",
+ "devdocs/build/arm.md",
+ "devdocs/build/distributing.md",
  ]
 ]
 

doc/build/build.md → doc/src/devdocs/build/build.md

@@ -66,7 +66,7 @@ Now you should be able to run Julia like this:
 
 If you are building a Julia package for distribution on Linux, macOS,
 or Windows, take a look at the detailed notes in
-[distributing.md](https://github.com/JuliaLang/julia/blob/master/doc/build/distributing.md).
+[distributing.md](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/distributing.md).
 
 ## Updating an existing source tree
 
@@ -130,14 +130,14 @@ latest version.
 
 Notes for various operating systems:
 
-* [Linux](https://github.com/JuliaLang/julia/blob/master/doc/build/linux.md)
-* [macOS](https://github.com/JuliaLang/julia/blob/master/doc/build/macos.md)
-* [Windows](https://github.com/JuliaLang/julia/blob/master/doc/build/windows.md)
-* [FreeBSD](https://github.com/JuliaLang/julia/blob/master/doc/build/freebsd.md)
+* [Linux](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/linux.md)
+* [macOS](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/macos.md)
+* [Windows](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/windows.md)
+* [FreeBSD](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/freebsd.md)
 
 Notes for various architectures:
 
-* [ARM](https://github.com/JuliaLang/julia/blob/master/doc/build/arm.md)
+* [ARM](https://github.com/JuliaLang/julia/blob/master/doc/src/devdocs/build/arm.md)
 
 ## Required Build Tools and External Libraries
 

doc/build/distributing.md → doc/src/devdocs/build/distributing.md

@@ -1,4 +1,4 @@
-Notes for building binary distributions
+Binary distributions
 =======================================
 
 These notes are for those wishing to compile a binary distribution of Julia

doc/build/freebsd.md → doc/src/devdocs/build/freebsd.md

@@ -1,4 +1,4 @@
-## FreeBSD
+# FreeBSD
 
 Clang is the default compiler on FreeBSD 11.0-RELEASE and above.
 The remaining build tools are available from the Ports Collection, and can be installed using

doc/build/linux.md → doc/src/devdocs/build/linux.md

@@ -1,20 +1,20 @@
-## Linux
+# Linux
 
 * GCC version 4.7 or later is required to build Julia.
 * To use external shared libraries not in the system library search path, set `USE_SYSTEM_XXX=1` and `LDFLAGS=-Wl,-rpath,/path/to/dir/contains/libXXX.so` in `Make.user`.
 * Instead of setting `LDFLAGS`, putting the library directory into the environment variable `LD_LIBRARY_PATH` (at both compile and run time) also works.
 * The `USE_SYSTEM_*` flags should be used with caution. These are meant only for troubleshooting, porting, and packaging, where package maintainers work closely with the Julia developers to make sure that Julia is built correctly. Production use cases should use the officially provided binaries. Issues arising from the use of these flags will generally not be accepted.
 * See also the [external dependencies](build.md#required-build-tools-and-external-libraries).
 
-### Architecture Customization
+## Architecture Customization
 
 Julia can be built for a non-generic architecture by configuring the `ARCH` Makefile variable in a `Make.user` file. See the appropriate section of `Make.inc` for additional customization options, such as `MARCH` and `JULIA_CPU_TARGET`.
 
 For example, to build for Pentium 4, set `MARCH=pentium4` and install the necessary system libraries for linking. On Ubuntu, these may include lib32gfortran-6-dev, lib32gcc1, and lib32stdc++6, among others.
 
 You can also set `MARCH=native` in `Make.user` for a maximum-performance build customized for the current machine CPU.
 
-### Linux Build Troubleshooting
+## Linux Build Troubleshooting
 
  Problem | Possible Solution
 ------------------------|---------------------

doc/build/macos.md → doc/src/devdocs/build/macos.md

@@ -1,4 +1,4 @@
-## macOS
+# macOS
 
 You need to have the current Xcode command line utilities installed: run `xcode-select --install` in the terminal. You will need to rerun this terminal command after each macOS update, otherwise you may run into errors involving missing libraries or headers.
 

doc/build/windows.md → doc/src/devdocs/build/windows.md

@@ -1,4 +1,4 @@
-# Julia on Windows
+# Windows
 
 This file describes how to install, or build, and use Julia on Windows.