소스 검색

Update getting_started.rst

add information about the environment variables.
Philip Berndroth 9 년 전
부모
커밋
4947eaff98
1개의 변경된 파일16개의 추가작업 그리고 2개의 파일을 삭제
  1. 16 2
      docs/user/getting_started.rst

+ 16 - 2
docs/user/getting_started.rst

@@ -42,6 +42,22 @@ will ensure all packages are rebuilt; this is what you normally want to do after
 will clean the entire tree, so the toolchain will be rebuilt as well, which is
 not necessary in most cases, and will take a while.
 
+
+Environment variables
+---------------------
+
+Gluon's build process can be controlled by various environment variables.
+
+GLUON_SITEDIR
+  Path to the site configuration. Defaults to ``site/``.
+
+GLUON_IMAGEDIR
+  Path where images will be stored. Defaults to ``images/``.
+
+GLUON_BUILDDIR
+  Working directory during build. Defaults to ``build/``.
+
+
 So all in all, to update and rebuild a Gluon build tree, the following commands should be used:
 
 ::
@@ -51,5 +67,3 @@ So all in all, to update and rebuild a Gluon build tree, the following commands
     make update
     make clean
     make
-
-