From 3c8ccd2a9c67793f182179e7c5a221841ee2b6e2 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Mon, 20 Feb 2017 21:07:59 +0100 Subject: [PATCH] Modified documentation now that submodule fetching isn't needed. --- CONTRIBUTING.md | 34 ++++++++++++++++++---------------- INSTALL.md | 13 ++----------- RELEASE-CHECKLIST | 3 ++- 3 files changed, 22 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9feb0b6a0..c011faeb9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -215,28 +215,30 @@ With stack: pandoc +RTS -p -RTS [file]... less pandoc.prof +Templates +--------- + +The default templates live in `data/templates`, which is a git +subtree linked to . +The purpose of maintaining a separate repository is to allow +people to maintain variant templates as a fork. + +You can modify the templates and submit patches without worrying +much about this: when these patches are merged, we will +push them to the main templates repository by doing + + git subtree push --prefix=data/templates templates master + +where `templates` is a remote pointing to the templates +repository. + The code -------- Pandoc has a publicly accessible git repository on github: . To get a local copy of the source: - git clone git://github.com/jgm/pandoc.git - -Note: after cloning the repository (and in the future after pulling from it), -you should do - - git submodule update --init - -to pull in changes to the templates (`data/templates/`). You can automate this -by creating a file `.git/hooks/post-merge` with the contents: - - #!/bin/sh - git submodule update --init - -and making it executable: - - chmod +x .git/hooks/post-merge + git clone https://github.com/jgm/pandoc.git The source for the main pandoc program is `pandoc.hs`. The source for the pandoc library is in `src/`, the source for the tests is in diff --git a/INSTALL.md b/INSTALL.md index 4f833b471..5918eea53 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -112,7 +112,6 @@ Or you can fetch the development code by cloning the repository: git clone https://github.com/jgm/pandoc cd pandoc - git submodule update --init # to fetch the templates Note: there may be times when the development code is broken or depends on other libraries which must be installed @@ -159,13 +158,6 @@ The easiest way to build pandoc from source is to use [stack]: cabal install - Note: If you obtained the source from the git repository (rather - than a release tarball), you'll need to do - - git submodule update --init - - to fetch the contents of `data/templates` before `cabal install`. - 4. Make sure the `$CABALDIR/bin` directory is in your path. You should now be able to run `pandoc`: @@ -329,14 +321,13 @@ maximal build method would be git clone https://github.com/jgm/cmark-hs git clone https://github.com/jgm/zip-archive cd pandoc - git submodule update --init stack install --test --install-ghc --stack-yaml stack.full.yaml To pull in the latest changes, after you've done this and there have been changes in the repositories: Visit each repository in pandoc-build (pandoc-types, texmath, pandoc-citeproc, pandoc, zip-archive, cmark-hs) and do -`git pull`. In the pandoc repo, also do `git submodule update` and `stack -install --test --stack-yaml stack.full.yaml`. +`git pull`. In the pandoc repo, also do `stack install --test +--stack-yaml stack.full.yaml`. [Arch]: https://www.archlinux.org/packages/community/x86_64/pandoc/ diff --git a/RELEASE-CHECKLIST b/RELEASE-CHECKLIST index 2882965e1..9262bbf0c 100644 --- a/RELEASE-CHECKLIST +++ b/RELEASE-CHECKLIST @@ -7,7 +7,8 @@ _ make man/pandoc.1 and commit if needed _ Tag release in git -_ Tag templates +_ Push templates: + git subtree push --prefix=data/templates templates master _ Generate Windows package (make winpkg)