Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve heap dumper documentation for SDK5 on device #1003

Merged
merged 2 commits into from
Aug 22, 2024

Conversation

akhabali
Copy link
Collaborator

No description provided.

@akhabali akhabali requested a review from frivieremicroej July 25, 2024 12:25
@akhabali akhabali self-assigned this Jul 25, 2024
@akhabali akhabali added the documentation Improvements or additions to documentation label Jul 25, 2024
@akhabali akhabali force-pushed the feature/heapDumperSDK5 branch from 537bca5 to 7dcaff6 Compare July 25, 2024 12:40
@akhabali
Copy link
Collaborator Author

SDKUserGuide/heapAnalyzer.rst Outdated Show resolved Hide resolved
@akhabali akhabali force-pushed the feature/heapDumperSDK5 branch from 395c729 to 77e3cbd Compare August 22, 2024 15:32
@akhabali akhabali merged commit 562e6e4 into master Aug 22, 2024
1 check passed
@akhabali akhabali deleted the feature/heapDumperSDK5 branch August 22, 2024 15:47
apielmicroej added a commit that referenced this pull request Sep 12, 2024
* add links to yocto binaries

* Fix yocto links

* rename Platform to VEE Port in ADG

* Add changelog for Architecture maintenance/7.20.5

* remove loadXXXConfiguration tasks and add execTool task in addon-library plugin

* document generateApplicationWrapper task

* Document Application Wrapper

* document how to install tools in a Virtual Device

* fix wrapper class main method

* document the buildApplicationObjectFile task

* document how to use runtime APIs

* Update gradle plugin version to 0.17.0.

* Additional SystemProperties for s3 coverage w/ SDK6

* add source pptx for kifaru diagrams

* remove old version of js_runtime pptx and move new pptx to correct pptx folder

* Add a going further section, clarify wording.

* Fix tables

* Define header in tables and fix typo

* review Security Manager implementation page

* Fix remarks

* Add VEE porting guide link and modify note.

* Fix typo and VEE wear link.

* Fix typo, add Gradle link

* Add a missing word

* Move GUI Software Robot from Tutorials to App Dev Guide / Deve Tools

* Move Detect Text Overflow Documentation to App Dev Guide / MWT Debug

* Move + update Add Emoji to Vector Font doc to App Dev Guide / MicroVG doc

* Move + Update intrument Code for Logging to App Dev Guide / Dev Tools section

* Move + Update Data Serialization Tutorial to App Dev Guide / Libraries

* Move + Update Add IAR to MICROEJ SDK Docker Image to SDK5 How To Guides

* Move + Update setup Build Using Jenkins And Artifactory to SDK5 How To Guides

* Move Run a Testsuite on Device doc to VEE Port Dev Guide / VEE Qualification

* Update rt1170 website link

* Update Architecture changelog with version 8.1.1

Co-authored-by: Frédéric RIVIERE <frederic.riviere@microej.com>

* Add troubleshooting for Windows path limit exceeded error

* Update Architecture release notes with version 8.1.1

* Move tutorialCreateCustomPlatform to VEE Porting Guide

* Add Introduction page

* Update KernelDeveloperGuide/applicationSecurityPolicy.rst

Co-authored-by: stinlot-microej <115997360+stinlot-microej@users.noreply.github.com>

* reword the introduction of securitymanager implementation

* Update KernelDeveloperGuide/applicationSecurityPolicy.rst

Co-authored-by: stinlot-microej <115997360+stinlot-microej@users.noreply.github.com>

* Add mock framework section

* Fix copyright

* Move UI tutorials to UI App Dev Guide

* Move + Update intrument Code for Logging to App Dev Guide / Dev Tools section

* Move + Update Data Serialization Tutorial to App Dev Guide / Libraries

* Remove GUI tutorials modifications

* Revert "Merge branch 'feature/M0127CC-763_move_tutorials_to_AppDevGuide' of github.com:MicroEJ/docs into feature/M0127CC-763_move_tutorials_to_AppDevGuide"

This reverts commit 598bb7d, reversing
changes made to a2f7e19.

* Update rt1170 website link

* Update Architecture changelog with version 8.1.1

Co-authored-by: Frédéric RIVIERE <frederic.riviere@microej.com>

* Add troubleshooting for Windows path limit exceeded error

* Update Architecture release notes with version 8.1.1

* Trigger CI build

* Update Mock Framework documentation

* Update ApplicationDeveloperGuide/guiSoftwareRobot.rst

* Detail where the Heap files are dumped

* Apply suggestions from code review

Co-authored-by: emoreac-microej <76094781+emoreac-microej@users.noreply.github.com>

* Fix Mock Framework doc following review

* Revert "Move + Update setup Build Using Jenkins And Artifactory to SDK5 How To Guides"

* Update time doc with tzdb support

* Minor typo fix

* Update after review

* set linkcheck to only test microej.com links and inner references

* keep old linkcheck_ignore patterns commented for occasional testing

* include github.com/MicroEJ, nxp.com and facer.io links in linkcheck

* Tzdb provider type is now required in types.list

* Add a reference to the tzdb resource size

* Add link to Mock Framework samples

* Note about Java compliance level settings in Eclipse is SDK 5 specific.

* Highlight "BSP Without GPU" prerequisite in UI Migration Guide

* Clarify how to enable the Flush Visualizer

* Add NLS in NLS page title to improve search results

* Update Flush Visualizer doc following review

* Add VEE Script doc

* Revert "Update Flush Visualizer doc following review"

This reverts commit cdb0ba2.

* Improve VEE Script doc

* Apply fixed from review

* Apply suggestions from code review

Co-authored-by: gharelMicroEJ <gaetan.harel@microej.com>

* Fix typo

* Fix title underline

* Fixed typo

* Revert "Move Tutorials Intrument Code for Logging & Data Serialization Tutorial to App Dev Guide"

* Move the following tutorials to the App Dev Guide:�- Instrument Java Code for Logging

- Explore Data Serialization Formats

* Remove unused images

* add SDK 5.9.0 changelog

* Explain how to configure VG Pack.

* Update VG changelog.

* Update VG release notes.

* Fix changelog and identify sections to update.

* fix build

* remove vglite

* introduce the custom extension (image gen and fp vg)

* review the tables in the release notes

* Update the names in vg_llapi_emb.png

* Update the documentation of the CCO MicroUI over NemaGFX

* Update the documentation for the CCO MicroVG over VGLite

* Update the documentation for the CCO MicroVG

* release notes of vg pack

* change the dma2d repository

* ui migration guide: replace "Copy" by "Transmit"

* remove invalid notions of vglite in microvg traces

* fix ui pack min version

* Update the documentation for the CCO MicroUI over VGLite

* simplify sumup of vg llapi (remove font.c)

* harmonize llapi vg matrix with other graphs

* fix llapi vg path

* fix llapi vg gradient

* fix llapi vg bvi

* fix llapi vg font

* fix cco vg

* Add the migration guide for the VG Pack 1.6.0

* Add the UI C module migration guide

* Add a build task

* Add links

* Remove an unreleased version

* Reword the UI migration guide

* Detail how to remove the interrupt mode

* Disable the link check for module repositories

* Update the UI migration guide about MicroUIGraphicsContext.setDrawingLimits

* Update the changelog and migration guide for the VG Pack

* Update the changelog and migration guide for the C Module MicroUI over DMA2D

* Move links to uiReplaces.rst

* Update the UI migration guide

* Fix the UI migration guide

* fix cco vg

* fix links

* Revert "Disable the link check for module repositories"

This reverts commit 9e241b7.

* fix vg changelog

* Explicit steps to use dumps generated by 'VEE memory dump macro script'

* Add bash command to merge .hex files

* Improve Font Loader Documentation

* ui pack 14.0.2

* Add back support of JDK 21 for SDK 6 since M0090IDE-4466 has been fixed

* Apply suggestions from code review

Co-authored-by: microej-sh <117637436+microej-sh@users.noreply.github.com>

* Fix Inject Application Options For a Specific Test doc

* Update Inject Application Options For a Specific Test doc

* Fix Oracle JDK download link: remove fr

* Update SDK 6 scope page to add the build of a Kernel Application

* Add Serial to Socket Transmitter in SDK 6 documentation

* improve heap dumper documentation for SDK5 on device (#1003)

* M0090IDE-4741 Document how to deploy an Executable without rebuilding it in SDK 6

* M0090IDE-4748 Add new SDK 6 0.18.0 version

* Add Shielded Plug limitations

* Fix rst build issue

* Add an how-to section to disable Ivy descriptor publication with SDK 6.

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: Rémy LOUEDEC <65411626+rlouedec-microej@users.noreply.github.com>

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: Rémy LOUEDEC <65411626+rlouedec-microej@users.noreply.github.com>

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: dbedin-microej <87306402+denisbedin@users.noreply.github.com>

* Fixes after review.

* Update SDK6UserGuide/howtos/disableIvyDescriptorPublication.rst

Co-authored-by: dbedin-microej <87306402+denisbedin@users.noreply.github.com>

* Add a link to Manage Versioning page from SDK 6 publication page.

* Fix typo on limitations

* Fix a link

* Clarify the UI migration guide

* Minimal documentation on howto create and configure a runtime-api project with SDK 6.

* Add runtime-api plugin tasks description.

* Update runtime environment page with SDK 6 runtime-api plugin.

* Add documentation for the motion library.

* add a note about ui traces

* migrate KF specifications to docs

* turn all tables to list-tables

* fix caption and anchors

* fix typos

* add missing images

* remove extra line skips

* fix conversion error

* update the KF header for docs

also synchronize latest KF API version

* fix indices

* remove [jls]

* review section links and footnotes

* add links to javadoc

* fix schemas scale

also remove duplicate png files

* sync shared interfaces specification

remove duplicates and merge content of the shared interface mechanism between ADG (user point of view) and KF spec (underlying runtime semantic)

* fix list & state typos

* sync the stop specification with javadoc

* Adding NET 11.1.0 testsuite versioning.

---------

Co-authored-by: Nicolas Houzé <nicolas.houze@microej.com>
Co-authored-by: Benjamin Alix <benjamin.alix@microej.com>
Co-authored-by: nhouze-microej <166010230+nhouze-microej@users.noreply.github.com>
Co-authored-by: Frédéric RIVIERE <frederic.riviere@microej.com>
Co-authored-by: Jerome Leroux <jerome.leroux@microej.com>
Co-authored-by: Denis BEDIN <denis.bedin@microej.com>
Co-authored-by: Benoit Guédas <benoit.guedas@microej.com>
Co-authored-by: dbedin-microej <87306402+denisbedin@users.noreply.github.com>
Co-authored-by: acolleux-microej <75476371+acolleux-microej@users.noreply.github.com>
Co-authored-by: ntinsalhi <naila.tinsalhi@microej.com>
Co-authored-by: Félix Pinel <felix.pinel@microej.com>
Co-authored-by: Gaëtan Harel <gaetan.harel@microej.com>
Co-authored-by: acolleux <alex.colleux@microej.com>
Co-authored-by: Corentin Blanchard <corentin.blanchard@microej.com>
Co-authored-by: Rémy LOUEDEC <remy.louedec@microej.com>
Co-authored-by: Rémy LOUEDEC <65411626+rlouedec-microej@users.noreply.github.com>
Co-authored-by: stinlot-microej <115997360+stinlot-microej@users.noreply.github.com>
Co-authored-by: Alexis Pineau <alexis.pineau@microej.com>
Co-authored-by: Stévann Tinlot <stevann.tinlot@microej.com>
Co-authored-by: microej-sh <117637436+microej-sh@users.noreply.github.com>
Co-authored-by: Thomas Delhoménie <thomas.delhomenie@microej.com>
Co-authored-by: emoreac-microej <76094781+emoreac-microej@users.noreply.github.com>
Co-authored-by: Thomas Pons <thomas.pons@microej.com>
Co-authored-by: Thomas Pons <48557644+thomasponsmicroej@users.noreply.github.com>
Co-authored-by: Benoit <49673585+bguedas@users.noreply.github.com>
Co-authored-by: gbalan-microej <guillaume.balan@microej.com>
Co-authored-by: Andy Poudret <andy.poudret@microej.com>
Co-authored-by: Andy Poudret <44900150+apoudret-microej@users.noreply.github.com>
Co-authored-by: Sébastien Eon <sebastien.eon@microej.com>
Co-authored-by: Anas KHABALI <anas.khabali@microej.com>
Co-authored-by: seonmej <65595892+seonmej@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

2 participants