Skip to content

Improve the documentation on how to use the java-profiler project#196

Merged
r1viollet merged 1 commit intomainfrom
r1viollet/improve-readme
Mar 24, 2025
Merged

Improve the documentation on how to use the java-profiler project#196
r1viollet merged 1 commit intomainfrom
r1viollet/improve-readme

Conversation

@r1viollet
Copy link
Copy Markdown
Contributor

What does this PR do?:

Improve the documentation on how to build and run the project.

Motivation:

The aim was to include some of the main commands you need to work with the project.

Additional Notes:

NA

How to test the change?:

This is a documentation change.

For Datadog employees:

  • If this PR touches code that signs or publishes builds or packages, or handles
    credentials of any kind, I've requested a review from @DataDog/security-design-and-guidance.
  • This PR doesn't touch any of that.
  • JIRA: [JIRA-XXXX]

Unsure? Have a question? Request a review!

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 23, 2025

🔧 Report generated by pr-comment-scanbuild

Scan-Build Report

User:runner@fv-az1718-112
Working Directory:/home/runner/work/java-profiler/java-profiler/ddprof-lib/src/test/make
Command Line:make -j4 clean all
Clang Version:Ubuntu clang version 18.1.3 (1ubuntu1)
Date:Sun Mar 23 20:04:21 2025

Bug Summary

Bug TypeQuantityDisplay?
All Bugs7
Logic error
Dereference of null pointer3
Suspicious operation
Bitwise shift1
Unused code
Dead initialization2
Dead nested assignment1

Reports

Bug Group Bug Type ▾ File Function/Method Line Path Length
Suspicious operationBitwise shiftvmStructs.cppfind90216
Unused codeDead initializationjavaApi.cppJava_com_datadoghq_profiler_JavaProfiler_getStatus01161
Unused codeDead initializationstackWalker.cppwalkDwarf1601
Unused codeDead nested assignmentvmStructs.cppcheckNativeBinding10071
Logic errorDereference of null pointersafeAccess.hload3318
Logic errorDereference of null pointersymbols_linux.hElfParser14428
Logic errorDereference of null pointerflightRecorder.cppflush15048

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 23, 2025

🔧 Report generated by pr-comment-cppcheck

CppCheck Report

Warnings (7)

Style Violations (398)

@r1viollet r1viollet force-pushed the r1viollet/improve-readme branch from dbb6a4a to bd22e70 Compare March 23, 2025 15:55
@r1viollet r1viollet force-pushed the r1viollet/improve-readme branch from bd22e70 to 719eeff Compare March 23, 2025 20:03
Copy link
Copy Markdown
Collaborator

@jbachorik jbachorik left a comment

Choose a reason for hiding this comment

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

Looking good!
Thanks!

@r1viollet r1viollet merged commit 6fa1618 into main Mar 24, 2025
93 of 94 checks passed
@github-actions github-actions Bot added this to the 1.23.0 milestone Mar 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants