Skip to content

Commit

Permalink
Merge pull request #11926 from JuliaLang/omm/doc-revert
Browse files Browse the repository at this point in the history
Revert manual conversion
  • Loading branch information
MikeInnes committed Jun 29, 2015
2 parents 5444813 + 8c5bc10 commit dcc4596
Show file tree
Hide file tree
Showing 32 changed files with 17,778 additions and 22,974 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ Make sure that [Travis](http://www.travis-ci.org) greenlights the pull request w
- Try to [squash](http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html) together small commits that make repeated changes to the same section of code so your pull request is easier to review, and Julia's history won't have any broken intermediate commits. A reasonable number of separate well-factored commits is fine, especially for larger changes.
- If any conflicts arise due to changes in Julia's `master`, prefer updating your pull request branch with `git rebase` versus `git merge` or `git pull`, since the latter will introduce merge commits that clutter the git history with noise that makes your changes more difficult to review.
- If you see any unrelated changes to submodules like `deps/libuv`, `deps/openlibm`, etc., try running `git submodule update` first.
- Avoid committing changes to auto-generated files such as `doc/stdlib/*.rst`, which is a frequent source of conflicts and can be re-generated later.
- Avoid committing changes to auto-generated files such as `doc/helpdb.jl`, which is a frequent source of conflicts and can be re-generated later.
- Descriptive commit messages are good.
- Using `git add -p` or `git add -i` can be useful to avoid accidentally committing unrelated changes.
- GitHub does not send notifications when you push a new commit to a pull request, so please add a comment to the pull request thread to let reviewers know when you've made changes.
Expand Down
6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ release-candidate: release test
@$(MAKE) -C doc latex SPHINXOPTS="-n" #Rebuild Julia PDF docs pedantically
@$(MAKE) -C doc doctest #Run Julia doctests
@$(MAKE) -C doc linkcheck #Check all links
@$(MAKE) -C doc helpdb.jl #Rebuild Julia online documentation for help(), apropos(), etc...

@# Check to see if the above make invocations changed anything important
@if [ -n "$$(git status --porcelain)" ]; then \
Expand Down Expand Up @@ -116,6 +117,9 @@ release-candidate: release test
@echo 10. Change master to release-0.X in base/version.jl and base/version_git.sh as in 4cb1e20
@echo

$(build_docdir)/helpdb.jl: doc/helpdb.jl | $(build_docdir)
@cp $< $@

$(build_man1dir)/julia.1: doc/man/julia.1 | $(build_man1dir)
@mkdir -p $(build_man1dir)
@cp $< $@
Expand Down Expand Up @@ -184,7 +188,7 @@ JULIA_SYSIMG_BUILD_FLAGS += --output-ji $(call cygpath_w,$(build_private_libdir)
endif

COMMA:=,
$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_private_libdir)/inference.$(SHLIB_EXT)
$(build_private_libdir)/sys.o: VERSION $(BASE_SRCS) $(build_docdir)/helpdb.jl $(build_private_libdir)/inference.$(SHLIB_EXT)
@$(call PRINT_JULIA, cd base && \
$(call spawn,$(JULIA_EXECUTABLE)) -C $(JULIA_CPU_TARGET) --output-o $(call cygpath_w,$(build_private_libdir)/sys.o) $(JULIA_SYSIMG_BUILD_FLAGS) -f \
-J $(call cygpath_w,$(build_private_libdir)/inference.$(SHLIB_EXT)) sysimg.jl \
Expand Down
5 changes: 4 additions & 1 deletion base/docs/Docs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,10 @@ macro repl (ex)
if $(isfield(ex) ? :(isa($(esc(ex.args[1])), DataType)) : false)
$(isfield(ex) ? :(fielddoc($(esc(ex.args[1])), $(ex.args[2]))) : nothing)
else
@doc $(esc(ex))
# Backwards-compatible with the previous help system, for now
let doc = @doc $(esc(ex))
doc nothing ? doc : Base.Help.@help_ $(esc(ex))
end
end
end
end
Expand Down
Loading

0 comments on commit dcc4596

Please sign in to comment.