Maintainer
buep

Memory Map plugin

This readme file mostly contains developer oriented documentation.

For user oriented documentation, please see the plugin's Jenkins wiki page

Introduction

The Memory Map plugin provides assistance for monitoring the memory map created by a linker. It is especially useful when development is being conducted in conditions where memory is limited, e.g. when developing for an embedded system. It allows for displaying memory map values throughout builds in a graph, making it easier to follow up on memory usage.

References

Plugin repositories

• Jenkins CI's repository on GitHub
• Praqma's repository on GitHub

Automated builds

• Praqma's Memory Map plugin build view
• Maven project Memory Map Plugin

Roadmap

See docs/roadmap.md-file.

Wiki and issue tracker

User oriented documentation can be found on the wiki:

• Memory Map plugin's Jenkins wiki page

We are not using the Jenkins CI community issue tracker any more. All issues are tracked using github issues.

Contributing

We happily accept pull requests on Praqma's Memory Map GitHub repository, where we also release from. Do not make pull requests on the Jenkins CI GitHub Repository - it is only used as final archive for released versions.

• Please reference a JIRA issue in your pull request.
• Please either include tests for your code changes or make sure your changes are covered by existing tests.
• Unless you are contributing a simple bug fix or feature implementation, please consult the Memory Map plugin's Trello board to discuss implementation ideas.

Developer details

See some of our initial research on compiler and linkers, and their memory map output, and get a grasp about the idea behind it all. Read the research notes in the docs folder.

See also the brief architecture illustration in docs/architecture.md.