annotate mod_measure_malloc/README.md @ 6084:4c0e3fe57e92

mod_compliance_latest: Gracefull error logging on missing dependency. diff --git a/mod_compliance_latest/README.md b/mod_compliance_latest/README.md --- a/mod_compliance_latest/README.md +++ b/mod_compliance_latest/README.md @@ -9,13 +9,15 @@ rockspec: # Introduction -This module will always require and load to the lastest compliance tester we have in the community modules. -Currently this is [mod_compliance_2023]. +This meta-module will always `require` (and therefore auto-load) the lastest compliance tester we have in the community modules. +Currently this is [mod_compliance_2023]. See the linked module for further details. + +If you do not use the *Prosody plugin installer* this module will likely have limited value to you. +You can also just install the current compliance tester manually. # Configuration -Just load this module as any other module and it will automatically install [mod_compliance_2023] if you use the Prosody plugin installer. -See the linked module for further details. +Just load this module as any other module and it will automatically install and load [mod_compliance_2023] if you use the *Prosody plugin installer*. # Compatibility diff --git a/mod_compliance_latest/mod_compliance_latest.lua b/mod_compliance_latest/mod_compliance_latest.lua --- a/mod_compliance_latest/mod_compliance_latest.lua +++ b/mod_compliance_latest/mod_compliance_latest.lua @@ -1,1 +1,6 @@ -module:depends("compliance_2023"); +local success, err = pcall(function() module:depends("compliance_2023") end) + +if not success then + module:log("error", "Error, can't load module: mod_compliance_2023. Is this module downloaded in a folder readable by prosody?") + return 1, "Error: Couldn't load dependency mod_compliance_2023." +end
author Menel <menel@snikket.de>
date Mon, 23 Dec 2024 12:58:03 +0100
parents fe081789f7b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2709
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 labels:
3174
f02c0f5e44ac various/README: Add a Statistics label
Kim Alvefur <zash@zash.se>
parents: 2709
diff changeset
3 - Statistics
f02c0f5e44ac various/README: Add a Statistics label
Kim Alvefur <zash@zash.se>
parents: 2709
diff changeset
4 summary: 'Report malloc() stats'
f02c0f5e44ac various/README: Add a Statistics label
Kim Alvefur <zash@zash.se>
parents: 2709
diff changeset
5 ---
2709
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 Description
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 ===========
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
4575
5b4f43b90766 mod_measure_malloc: port to most recent trunk statistics API
Jonas Schäfer <jonas@wielicki.name>
parents: 3174
diff changeset
10 This module collects stats from `util.pposix.meminfo` usage and reports using Prosody 0.12 APIs
2709
2e61642d2ff0 mod_measure_malloc: Add a short README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11