You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@metron.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2018/04/12 11:21:00 UTC

[jira] [Commented] (METRON-1522) Fix the typo errors at profile debugger readme

    [ https://issues.apache.org/jira/browse/METRON-1522?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16435374#comment-16435374 ] 

ASF GitHub Bot commented on METRON-1522:
----------------------------------------

GitHub user MohanDV opened a pull request:

    https://github.com/apache/metron/pull/992

    METRON-1522: Fix the typo errors at profiler debugger readme

    ## Contributor Comments
    Fix the typo errors at profiler debugger readme to keep the profile name consistent in flush profile section and reference to the profile across sections.
    
    ## Pull Request Checklist
    
    Thank you for submitting a contribution to Apache Metron.  
    Please refer to our [Development Guidelines](https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=61332235) for the complete guide to follow for contributions.  
    Please refer also to our [Build Verification Guidelines](https://cwiki.apache.org/confluence/display/METRON/Verifying+Builds?show-miniview) for complete smoke testing guides.  
    
    
    In order to streamline the review of the contribution we ask you follow these guidelines and ask you to double check the following:
    
    ### For all changes:
    - [x] Is there a JIRA ticket associated with this PR? If not one needs to be created at [Metron Jira](https://issues.apache.org/jira/browse/METRON/?selectedTab=com.atlassian.jira.jira-projects-plugin:summary-panel).
    - [x] Does your PR title start with METRON-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    - [x] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    
    ### For code changes:
    - [ ] Have you included steps to reproduce the behavior or problem that is being changed or addressed?
    - [ ] Have you included steps or a guide to how the change may be verified and tested manually?
    - [ ] Have you ensured that the full suite of tests and checks have been executed in the root metron folder via:
      ```
      mvn -q clean integration-test install && dev-utilities/build-utils/verify_licenses.sh 
      ```
    
    - [ ] Have you written or updated unit tests and or integration tests to verify your changes?
    - [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
    - [ ] Have you verified the basic functionality of the build by building and running locally with Vagrant full-dev environment or the equivalent?
    
    ### For documentation related changes:
    - [x] Have you ensured that format looks appropriate for the output in which it is rendered by building and verifying the site-book? If not then run the following commands and the verify changes via `site-book/target/site/index.html`:
    
      ```
      cd site-book
      mvn site
      ```
    
    #### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.
    It is also recommended that [travis-ci](https://travis-ci.org) is set up for your personal repository such that your branches are built there before submitting a pull request.


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

    $ git pull https://github.com/MohanDV/metron METRON-1522

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

    https://github.com/apache/metron/pull/992.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 #992
    
----
commit b5e151af7602e5bde247dc1b6cd6592fcb467e1a
Author: Mohan Venkateshaiah <mo...@...>
Date:   2018-04-12T11:05:39Z

    update the doc to fix typo errors.

----


> Fix the typo errors at profile debugger readme 
> -----------------------------------------------
>
>                 Key: METRON-1522
>                 URL: https://issues.apache.org/jira/browse/METRON-1522
>             Project: Metron
>          Issue Type: Bug
>            Reporter: Mohan
>            Assignee: Mohan
>            Priority: Trivial
>
> https://github.com/apache/metron/tree/master/metron-analytics/metron-profiler#creating-profiles 
> There is typo error at step 6 , The profile name has been used as 'p' and 'profiler' at places . 
> {code:java}
> [Stellar]>>> values := PROFILER_FLUSH(profiler) 
> {code}
> it should be 
> {code:java}
> [Stellar]>>> values := PROFILER_FLUSH(p)
> {code}
> Or to keep it consistent across the sections the profile definition should be renamed to 'profiler' instead of 'p'  



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)