Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Fix scala doc build break for v1.3.1 #13820

Merged
merged 2 commits into from
Jan 10, 2019
Merged

Conversation

frankfliu
Copy link
Contributor

Description

mxdoc.py was used to build both old and new version of website. scala doc build script need to be backward compatible.

This fix the backward compatibility issue introduced by: #13626

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http:https://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@frankfliu frankfliu requested a review from szha as a code owner January 9, 2019 18:13
@anirudhacharya
Copy link
Member

@mxnet-label-bot add [pr-awaiting-review, Scala]

@marcoabreu marcoabreu added pr-awaiting-review PR is waiting for code review Scala labels Jan 9, 2019
Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still getting errors with this recent change:

Command 'cd /home/ubuntu/incubator-mxnet/docs/build_version_doc/apache-mxnet/v1.3.x/docs/../scala-package; scaladoc `find . -type f -name "*.scala" | egrep "\.\/core|\.\/infer" | egrep -v "\/javaapi"  | egrep -v "Suite"` -classpath `find native -name "*.jar" | grep "target/lib/" | tr "\n" ":" `:`find infer -name "*.jar" | tr "\n" ":" ` -feature -deprecation ' returned non-zero exit status 1

I added 1.3. to the "get out of jail free" line and it works. I don't know what needs to be fixed for these old versions. If it's okay to just skip the problem, well, then here you go.

Change the line 115 to:

    scala_ignore_errors = '; exit 0' if '1.2.' or '1.3.' in _BUILD_VER else ''

I tested this change on v1.4.x and no error, so it looks like we only have the issue with 1.2.x and 1.3.x.

@apache apache deleted a comment from codecov-io Jan 10, 2019
@aaronmarkham aaronmarkham merged commit 5aeed01 into apache:master Jan 10, 2019
@frankfliu frankfliu deleted the doc branch January 11, 2019 00:01
zhaoyao73 added a commit to zhaoyao73/incubator-mxnet that referenced this pull request Jan 11, 2019
* upstream/master: (109 commits)
  Code modification for  testcases of various network models in directory example (apache#12498)
  [CI] Prevent timeouts when rebuilding containers with docker. (apache#13818)
  fix Makefile for rpkg (apache#13590)
  change to compile time (apache#13835)
  Disabled flaky test (apache#13758)
  Improve license_header tool by only traversing files under revision c… (apache#13803)
  Removes unneeded nvidia driver ppa installation (apache#13814)
  Add Local test stage and option to jump directly to menu item from commandline (apache#13809)
  Remove MXNET_STORAGE_FALLBACK_LOG_VERBOSE from test_autograd.py (apache#13830)
  Fix scala doc build break for v1.3.1 (apache#13820)
  [MXNET-1263] Unit Tests for Java Predictor and Object Detector APIs (apache#13794)
  [MXNET-1260] Float64 DType computation support in Scala/Java (apache#13678)
  onnx export ops (apache#13821)
  [MXNET-880] ONNX export: Random uniform, Random normal, MaxRoiPool (apache#13676)
  fix minor indentation (apache#13827)
  Fixing a symlink issue with R install (apache#13708)
  remove useless code (apache#13777)
  ONNX ops: norm exported and lpnormalization imported (apache#13806)
  Add new Maven build for Scala package (apache#13819)
  Dockerfiles for Publish Testing (apache#13707)
  ...
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
* Fix doc build break for v1.3.1

* ignore errors on v1.3.x during scala docs gen
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-review PR is waiting for code review Scala
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants