You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by bowenli86 <gi...@git.apache.org> on 2018/05/31 23:17:49 UTC

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

GitHub user bowenli86 opened a pull request:

    https://github.com/apache/flink/pull/6109

    [FLINK-9483] 'Building Flink' doc doesn't highlight quick build command

    ## What is the purpose of the change
    
    The blue part isn't corrected highlighted as the red ones
    
    ![screen shot 2018-05-31 at 4 12 32 pm](https://user-images.githubusercontent.com/1892692/40813097-ff439950-64ed-11e8-8a10-512934d89116.png)
    
    ## Brief change log
    
    Highlight quick build command
    
    ## Verifying this change
    
    This change is a trivial rework / code cleanup without any test coverage.
    
    ## Does this pull request potentially affect one of the following parts:
    
    none
    
    ## Documentation
    
    none

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/bowenli86/flink FLINK-9483

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/6109.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #6109
    
----
commit 8ea6f791de0266f481c45d03731d15ed999ea753
Author: Bowen Li <bo...@...>
Date:   2018-05-31T23:15:41Z

    [FLINK-9483] 'Building Flink' doc doesn't highlight quick build command

----


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:

    https://github.com/apache/flink/pull/6109


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by bowenli86 <gi...@git.apache.org>.
Github user bowenli86 commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192628940
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    +
    +{% highlight bash %}
    +mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
    --- End diff --
    
    https://github.com/apache/flink/blob/56df6904688642b1c8f9a287646c163dfae7edfd/pom.xml#L639


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by Aitozi <gi...@git.apache.org>.
Github user Aitozi commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192628465
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    +
    +{% highlight bash %}
    +mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
    --- End diff --
    
    A little question, what is the meaning of the `-Dfast` ?


---

[GitHub] flink issue #6109: [FLINK-9483] 'Building Flink' doc doesn't highlight quick...

Posted by bowenli86 <gi...@git.apache.org>.
Github user bowenli86 commented on the issue:

    https://github.com/apache/flink/pull/6109
  
    cc @zentol 


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192347573
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    --- End diff --
    
    replace `checkstyle` with `QA-plugins`


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192553046
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    --- End diff --
    
    quality-assurance plugins, like checkstyle, rat, japicmp, enforcer etc. . Guess we'll need an easier to understand name :/


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by zentol <gi...@git.apache.org>.
Github user zentol commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192347684
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    +
    +{% highlight bash %}
    +mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true
    --- End diff --
    
    replace `-Dmaven.javadoc.skip=true -Dcheckstyle.skip=true` with `-Dfast` 


---

[GitHub] flink pull request #6109: [FLINK-9483] 'Building Flink' doc doesn't highligh...

Posted by bowenli86 <gi...@git.apache.org>.
Github user bowenli86 commented on a diff in the pull request:

    https://github.com/apache/flink/pull/6109#discussion_r192535262
  
    --- Diff: docs/start/building.md ---
    @@ -50,7 +50,11 @@ mvn clean install -DskipTests
     
     This instructs [Maven](http://maven.apache.org) (`mvn`) to first remove all existing builds (`clean`) and then create a new Flink binary (`install`).
     
    -To speed up the build you can skip tests, checkstyle, and JavaDocs: `mvn clean install -DskipTests -Dmaven.javadoc.skip=true -Dcheckstyle.skip=true`.
    +To speed up the build you can skip tests, checkstyle, and JavaDocs:
    --- End diff --
    
    What's `QA-plugins`? Do you mean the set of QA checks in `tools/qa-check.sh`?


---

[GitHub] flink issue #6109: [FLINK-9483] 'Building Flink' doc doesn't highlight quick...

Posted by dawidwys <gi...@git.apache.org>.
Github user dawidwys commented on the issue:

    https://github.com/apache/flink/pull/6109
  
    +1, merging


---