qmk/docs
Stefan Kerkmann d210590d4d
[Maintenance] builddefs: common_rules: overhaul debug information generation (#24352)
builddefs: common_rules: overhaul debug information generation

Debug information is always generated while compiling a binary, but
debugging is not the main use-case for the majority of users. Thus the
new default is to explicitly require them with `DEBUG_ENABLE=yes`. The
same is true for linker map files which are gated by the same flag.

As we target the gcc compiler and debug with the gdb debugger we can
specify the ggdb3 flag in the most verbose to get macro expansion.

Signed-off-by: Stefan Kerkmann <karlk90@pm.me>
2024-09-01 19:54:53 +02:00
..
ChangeLog Changelog update with actual qmk_userspace_via link. (#24332) 2024-08-26 23:05:45 +01:00
drivers Merge remote-tracking branch 'origin/master' into develop 2024-07-23 10:37:50 +00:00
features Merge remote-tracking branch 'origin/master' into develop 2024-08-31 03:44:35 +00:00
public Ensure documentation pull requests build (#23908) 2024-06-13 02:59:37 +01:00
__capabilities_inc.md Add embed to docs capabilities (#23698) 2024-05-12 03:26:11 +10:00
__capabilities.md [docs] Remove gitbook directory (#23839) 2024-06-01 10:37:40 +10:00
_aliases.json Remove references to bootloadHID flashing page in keyboard readmes (#23942) 2024-06-17 20:23:45 +01:00
_sidebar.json 2024q3 breaking changes changelog (#24324) 2024-08-26 09:46:12 +10:00
api_development_environment.md
api_development_overview.md
api_docs.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
api_overview.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
arm_debugging.md
breaking_changes_history.md 2024q3 breaking changes changelog (#24324) 2024-08-26 09:46:12 +10:00
breaking_changes_instructions.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
breaking_changes.md Update next breaking changes date (#24331) 2024-08-26 15:14:06 +10:00
chibios_upgrade_instructions.md Update branch names to reflect configurator's new deployment. (#19999) 2023-03-03 14:16:06 +11:00
cli_commands.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
cli_configuration.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
cli_development.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
cli_tab_complete.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
cli.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
coding_conventions_c.md [Docs] Code markdown amendment (#21323) 2023-06-20 20:58:13 -06:00
coding_conventions_python.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
compatible_microcontrollers.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
config_options.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
configurator_architecture.md Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_default_keymaps.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
configurator_diagram.drawio Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_diagram.svg Architecture documentation for Configurator and API (#13935) 2021-08-10 07:47:53 -07:00
configurator_step_by_step.md Remove suggestion of creating issues for unsupported keyboards. (#23918) 2024-06-14 00:23:57 +01:00
configurator_troubleshooting.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
contributing.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
custom_matrix.md Remove matrix_init_quantum/matrix_scan_quantum (#19806) 2023-02-11 03:47:17 +00:00
custom_quantum_functions.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
data_driven_config.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
documentation_best_practices.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
documentation_templates.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
driver_installation_zadig.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
easy_maker.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_build.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_debug.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_general.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
faq_keymap.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
faq_misc.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
feature_advanced_keycodes.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_converters.md Rename promicro_rp2040 converter to sparkfun_pm2040 (#24192) 2024-07-25 22:51:32 +01:00
feature_debounce_type.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
feature_eeprom.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_layers.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_layouts.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
feature_macros.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
feature_userspace.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
flashing.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
fuse.txt
getting_started_docker.md doc: "docker getting started" mentions flash limitations (#24336) 2024-09-01 10:59:21 -06:00
getting_started_github.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
getting_started_introduction.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
getting_started_make_guide.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
hand_wire.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
hardware_drivers.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
hardware_keyboard_guidelines.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
how_a_matrix_works.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
how_keyboards_work.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
index.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
isp_flashing_guide.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
keycodes_basic.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
keycodes_magic.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
keycodes_us_ansi_shifted.md [Docs] Address some typos (also in moonlander matrix.c) (#16248) 2022-02-06 17:36:44 +00:00
keycodes.md Add new connection keycodes for Bluetooth, 2.4GHz. (#24251) 2024-08-27 10:52:23 +10:00
keymap.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
mod_tap.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
newbs_building_firmware_configurator.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_building_firmware_workflow.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
newbs_building_firmware.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
newbs_external_userspace.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_flashing.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
newbs_getting_started.md [docs] Fix code blocks overflowing page width (#23829) 2024-05-30 10:00:28 +01:00
newbs_git_best_practices.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_resolving_merge_conflicts.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_resynchronize_a_branch.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_git_using_your_master_branch.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs_learn_more_resources.md [Docs] Refactor code examples (#18003) 2022-08-12 17:27:24 -07:00
newbs_testing_debugging.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
newbs.md Docs theme updates (#23832) 2024-05-31 10:34:30 +10:00
one_shot_keys.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
other_eclipse.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
other_vscode.md [Maintenance] builddefs: common_rules: overhaul debug information generation (#24352) 2024-09-01 19:54:53 +02:00
platformdev_blackpill_f4x1.md Docs: typo fixes in platformdev_blackpill_f4x1.md (#19635) 2023-01-19 16:09:11 -07:00
platformdev_chibios_earlyinit.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
platformdev_proton_c.md Add converter docs (#17593) 2022-07-08 22:49:16 +01:00
platformdev_rp2040.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
platformdev_selecting_arm_mcu.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
porting_your_keyboard_to_qmk.md Fix dead link in porting_your_keyboard_to_qmk.md (#24306) 2024-08-19 20:04:37 +01:00
power.txt
pr_checklist.md Update PR Checklist for 'via' keymaps (#24330) 2024-08-27 07:28:23 +10:00
quantum_keycodes.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_lvgl.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_qff.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_qgf.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter_rle.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
quantum_painter.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
ref_functions.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
reference_configurator_support.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
reference_glossary.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
reference_info_json.md Move split.soft_serial_pin to split.serial.pin (#24127) 2024-07-18 09:02:53 +10:00
reference_keymap_extras.md add farsi keymap extras (#23650) 2024-06-20 16:12:16 -07:00
squeezing_avr.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
support_deprecation_policy.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
support.md Update Discord URL (#24283) 2024-08-15 14:37:27 +01:00
syllabus.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
tap_hold.md [docs] Organize driver & feature docs into subfolders (#23848) 2024-06-02 12:42:24 +10:00
understanding_qmk.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
unit_testing.md Vitepress conversion of docs. (#23795) 2024-05-30 12:00:41 +10:00
usb_nkro.txt