vimix/docs/notes.txt

Various Notes and reminders
===========================
Copyright 2024 Bruno Herbelin



Publishing new a release
------------------------

- Update share/metainfo/io.github.brunoherbelin.Vimix.metainfo.xml
  Add a <release>, with date and version number
- Update snap/snapcraft.yaml
  Change version string
- commit to Beta
  
- Test the flatpack for Beta
  https://github.com/brunoherbelin/vimix/tree/master/flatpak
- Test the snap for Beta

- Merge Beta into origin/master
- Create Release & Tag in https://github.com/brunoherbelin/vimix
  Document new features and major bugfixes

- Edit the Json on https://github.com/flathub/io.github.brunoherbelin.Vimix
  Set vimix git Tag and Commit #
  Merge pull-request after successful flathubbot compilation
  (delete branch)
- Follow-up status of flathub package build on https://buildbot.flathub.org
  (link is sent by email)



Mac OSX specificities
------------------------

- Settings are saved in /Users/[username]/Library/Application Support/vimix
  Instructions to reset in finder, do "Go to folder" (shift+command+G),
  enter "/Users/[username]/Library/Application Support/vimix" and delete the folder 'vimix'

-


Testing performance
-------------------

Linux perf command
- Allow perf on your system
sudo sysctl -w kernel.perf_event_paranoid=-1
- Launch command to record
perf record ./vimix
perf record --pid=XXXXX
- Analyse using https://github.com/KDAB/hotspot



Memcheck
--------

To generate memory usage plots in [massif format](https://valgrind.org/docs/manual/ms-manual.html):

    G_SLICE=always-malloc valgrind --tool=massif ./vimix

To check for memory leaks:

    G_SLICE=always-malloc valgrind --leak-check=full --log-file=vimix_mem.txt ./vimix