move index.html to docs/

See mxe#1500

Makefile

@@ -50,12 +50,12 @@ TIMESTAMP  := $(shell date +%Y%m%d_%H%M%S)
 PKG_DIR    := $(PWD)/pkg
 TMP_DIR     = $(MXE_TMP)/tmp-$(1)
 PKGS       := $(call set_create,\
-    $(shell $(SED) -n 's/^.* class="package">\([^<]*\)<.*$$/\1/p' '$(TOP_DIR)/index.html'))
+    $(shell $(SED) -n 's/^.* class="package">\([^<]*\)<.*$$/\1/p' '$(TOP_DIR)/docs/index.html'))
 BUILD      := $(shell '$(EXT_DIR)/config.guess')
 PATH       := $(PREFIX)/$(BUILD)/bin:$(PREFIX)/bin:$(PATH)
 
 # All pkgs have (implied) order-only dependencies on MXE_CONF_PKGS.
-# These aren't meaningful to the pkg list in index.html so
+# These aren't meaningful to the pkg list in docs/index.html so
 # use a list in case we want to separate autotools, cmake etc.
 MXE_CONF_PKGS := mxe-conf
 PKGS          += $(MXE_CONF_PKGS)
@@ -269,7 +269,7 @@ else
     $(info [create settings.mk])
     $(shell { \
         echo '# This is a template of configuration file for MXE. See'; \
-        echo '# index.html for more extensive documentations.'; \
+        echo '# docs/index.html for more extensive documentations.'; \
         echo; \
         echo '# This variable controls the number of compilation processes'; \
         echo '# within one package ("intra-package parallelism").'; \
@@ -369,7 +369,7 @@ $(PREFIX)/installed/check-requirements: $(MAKEFILE) | $(PREFIX)/installed/.gitke
 	$(call CHECK_REQUIREMENT_VERSION,automake,1\.11\.[3-9]\|1\.[1-9][2-9]\(\.[0-9]\+\)\?)
 	@if [ -e check-requirements-failed ]; then \
 	    echo; \
-	    echo 'Please have a look at "index.html" to ensure'; \
+	    echo 'Please have a look at "docs/index.html" to ensure'; \
 	    echo 'that your system meets all requirements.'; \
 	    echo; \
 	    rm check-requirements-failed; \
@@ -437,7 +437,7 @@ define TARGET_RULE
 	    @echo 'Warning: Deprecated target name $(1) specified'
 	    @echo
 	    @echo 'Please use $(1).[$(subst $(space),|,$(MXE_LIB_TYPES))] instead'
-	    @echo 'See index.html for further information'
+	    @echo 'See docs/index.html for further information'
 	    @echo '------------------------------------------------------------'
 	    @echo)
 endef
@@ -642,7 +642,7 @@ show-deps-%:
 	        $(newline)$(newline)$* downstream dependents:$(newline)\
 	        $(call WALK_DOWNSTREAM,$*))\
 	    @echo,\
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 # show upstream dependencies and downstream dependents separately
 # suitable for usage in shell with: `make show-downstream-deps-foo`
@@ -652,14 +652,14 @@ show-downstream-deps-%:
 	    $(call SET_CLEAR,PKGS_VISITED)\
 	    $(info $(call WALK_DOWNSTREAM,$*))\
 	    @echo -n,\
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 show-upstream-deps-%:
 	$(if $(call set_is_member,$*,$(PKGS)),\
 	    $(call SET_CLEAR,PKGS_VISITED)\
 	    $(info $(call WALK_UPSTREAM,$*))\
 	    @echo -n,\
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 # print first level pkg deps for use in build-pkg.lua
 .PHONY: print-deps-for-build-pkg
@@ -717,13 +717,13 @@ update:
 update-package-%:
 	$(if $(call set_is_member,$*,$(PKGS)), \
 	    $(and $($*_UPDATE),$(call UPDATE,$*,$(shell $($*_UPDATE)))), \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 update-checksum-%:
 	$(if $(call set_is_member,$*,$(PKGS)), \
 	    $(call DOWNLOAD_PKG_ARCHIVE,$*) && \
 	    $(SED) -i 's/^\([^ ]*_CHECKSUM *:=\).*/\1 '"`$(call PKG_CHECKSUM,$*)`"'/' '$($*_MAKEFILE)', \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 .PHONY: cleanup-style
 define CLEANUP_STYLE
@@ -742,7 +742,7 @@ define CLEANUP_STYLE
 
 endef
 cleanup-style:
-	$(foreach FILE,$(wildcard $(addprefix $(TOP_DIR)/,Makefile index.html CNAME src/*.mk src/*test.* tools/*)),$(call CLEANUP_STYLE,$(FILE)))
+	$(foreach FILE,$(wildcard $(addprefix $(TOP_DIR)/,Makefile docs/index.html CNAME src/*.mk src/*test.* tools/*)),$(call CLEANUP_STYLE,$(FILE)))
 
 .PHONY: cleanup-deps-style
 cleanup-deps-style:

index.html → docs/index.html

@@ -6,7 +6,7 @@
 
     <title>MXE (M cross environment)</title>
 
-    <link rel="stylesheet" href="docs/assets/common.css">
+    <link rel="stylesheet" href="assets/common.css">
 
 </head>
 <body>
@@ -125,7 +125,7 @@ <h3>Supported Toolchains</h3>
     </table>
     <p>
         These numbers were last updated on December 16, 2015.
-        See the <a href="docs/build-matrix.html">current status</a>
+        See the <a href="build-matrix.html">current status</a>
         for individual packages.
     </p>
     <p>
@@ -147,15 +147,15 @@ <h2 id="screenshots">Screenshots</h2>
     Cross compiling
     <a href="http://thebeez.home.xs4all.nl/4tH/">4tH</a>:
     </p>
-    <a href="docs/assets/screenshot-4th-compile.png">
-        <img src="docs/assets/screenshot-4th-compile-small.png" alt="4th-compile">
+    <a href="assets/screenshot-4th-compile.png">
+        <img src="assets/screenshot-4th-compile-small.png" alt="4th-compile">
     </a>
 
     <p>
     and running it:
     </p>
-    <a href="docs/assets/screenshot-4th-run.png">
-        <img src="docs/assets/screenshot-4th-run-small.png" alt="4th-run">
+    <a href="assets/screenshot-4th-run.png">
+        <img src="assets/screenshot-4th-run-small.png" alt="4th-run">
     </a>
 </div>
 
@@ -1055,7 +1055,7 @@ <h2 id="usage">Usage</h2>
         <dd>
         generate a report of what packages are
         supported on what targets to
-        <a href="docs/build-matrix.html">docs/build-matrix.html</a>
+        <a href="build-matrix.html">docs/build-matrix.html</a>
         </dd>
 
     <dt>make update</dt>
@@ -2832,7 +2832,7 @@ <h2 id="packages">List of Packages</h2>
         }
         function loadVersionCache(doneCallback, errCallback) {
             var request = new XMLHttpRequest();
-            request.open('GET', 'docs/versions.json', true);
+            request.open('GET', 'versions.json', true);
             request.onreadystatechange = function reqCallback() {
                 if (request.readyState === 4) {
                     if (request.status === 200) {
@@ -2943,7 +2943,7 @@ <h2 id="creating-packages">Guidelines for Creating Packages</h2>
         </p>
 
         <p>
-        The <a href="docs/gmsl.html">GNU Make Standard Library</a> is also
+        The <a href="gmsl.html">GNU Make Standard Library</a> is also
         available (though it should be unnecessary for most packages).
         </p>
 

docs/release-process.txt

@@ -9,7 +9,7 @@
     github issue
     MXE mailing list
     use the following to check for new/changed requirements:
-        http://htmlpreview.github.io/?https://raw.github.com/mxe/mxe/master/index.html
+        http://htmlpreview.github.io/?https://raw.github.com/mxe/mxe/master/docs/index.html
 ...
 
 - Fast-forward the stable branch to master:

patch.mk

@@ -63,26 +63,26 @@ init-git-%: download-only-%
 	    $(if $(wildcard $(call GIT_DIR,$*)), \
 	        $(error $(call GIT_DIR,$*) already exists), \
 	        $(call INIT_GIT,$*)), \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 import-patch-%:
 	$(if $(call set_is_member,$*,$(PKGS)), \
 	    $(if $(wildcard $(call GIT_DIR,$*)), \
 	        $(call IMPORT_PATCH,$*,$(call PATCH_BY_NAME,$*,$(PATCH_NAME))), \
 	        $(error $(call GIT_DIR,$*) does not exist)), \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 import-all-patches-%:
 	$(if $(call set_is_member,$*,$(PKGS)), \
 	    $(if $(wildcard $(call GIT_DIR,$*)), \
 	        $(foreach PKG_PATCH,$(call PKG_PATCHES,$*), \
 	            $(call IMPORT_PATCH,$*,$(PKG_PATCH))), \
 	        $(error $(call GIT_DIR,$*) does not exist)), \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))
 
 export-patch-%:
 	$(if $(call set_is_member,$*,$(PKGS)), \
 	    $(if $(wildcard $(call GIT_DIR,$*)), \
 	        $(call EXPORT_PATCH,$*,$(PATCH_NAME)), \
 	        $(error $(call GIT_DIR,$*) does not exist)), \
-	    $(error Package $* not found in index.html))
+	    $(error Package $* not found in docs/index.html))

src/fdk-aac.mk

@@ -1,7 +1,7 @@
 # This file is part of MXE. See LICENSE.md for licensing information.
 
 # WARNING: Like openssl, the license of this package is not compatible with
-# GPL 2+, but it is with LGPL 2.1+. See index.html#potential-legal-issues
+# GPL 2+, but it is with LGPL 2.1+. See docs/index.html#potential-legal-issues
 
 PKG             := fdk-aac
 $(PKG)_IGNORE   :=

src/ffmpeg.mk

@@ -15,7 +15,7 @@ $(PKG)_DEPS     := gcc bzip2 gnutls lame libass libbluray libbs2b libcaca \
 # DO NOT ADD fdk-aac OR openssl SUPPORT.
 # Although they are free softwares, their licenses are not compatible with
 # the GPL, and we'd like to enable GPL in our default ffmpeg build.
-# See index.html#potential-legal-issues
+# See docs/index.html#potential-legal-issues
 
 define $(PKG)_UPDATE
     $(WGET) -q -O- 'http://ffmpeg.org/releases/' | \

tools/build-pkg.lua

@@ -975,7 +975,7 @@ local function makeDebs(items, item2deps, item2ver, item2files)
 end
 
 local function getMxeVersion()
-    local index_html = io.open 'index.html'
+    local index_html = io.open 'docs/index.html'
     local text = index_html:read('*all')
     index_html:close()
     return text:match('Release ([^<]+)')
@@ -1032,7 +1032,6 @@ local function makeMxeSourcePackage()
         'README.md',
         'docs',
         'ext',
-        'index.html',
         'src',
         'plugins',
         'tools',

tools/skeleton.py

@@ -128,7 +128,7 @@ def make_build(options, builder):
 
 def update_index_html(name, description, website):
     # read HTML and find a list of packages
-    with open('index.html', 'rb') as f:
+    with open('docs/index.html', 'rb') as f:
         index_html = f.read()
         if not isinstance(index_html, str):
             # Python 3
@@ -171,7 +171,7 @@ def update_index_html(name, description, website):
     (_, tmp_index_html) = tempfile.mkstemp()
     with open(tmp_index_html, 'wt') as f:
         f.write(index_html)
-    os.rename(tmp_index_html, 'index.html')
+    os.rename(tmp_index_html, 'docs/index.html')
 
 def make_skeleton(
     name,