.github/workflows/ci.yml

@@ -32,23 +32,43 @@ jobs:
       - name: Build (puffin)
         run: cargo build --package=profiling --features=profile-with-puffin
 
+      - name: Build (puffin example)
+        run: cargo build --package=profiling --features=profile-with-puffin --example=simple
+
       - name: Build (superluminal)
         if: ${{ runner.os == 'Windows' && matrix.toolchain == 'stable' }}
         run: cargo build --package=profiling --features=profile-with-superluminal
 
+      - name: Build (superluminal example)
+        if: ${{ runner.os == 'Windows' && matrix.toolchain == 'stable' }}
+        run: cargo build --package=profiling --features=profile-with-superluminal --example=simple
+
       - name: Build (optick)
         if: ${{ runner.os == 'Windows' && matrix.toolchain == 'stable' }}
         run: cargo build --package=profiling --features=profile-with-optick
 
+      - name: Build (optick example)
+        if: ${{ runner.os == 'Windows' && matrix.toolchain == 'stable' }}
+        run: cargo build --package=profiling --features=profile-with-optick --example=simple
+
       - name: Build (tracing)
         run: cargo build --package=profiling --features=profile-with-tracing
 
+      - name: Build (tracing example)
+        run: cargo build --package=profiling --features=profile-with-tracing --example=simple
+
       - name: Build (tracy)
         run: cargo build --package=profiling --features=profile-with-tracy
 
+      - name: Build (tracy example)
+        run: cargo build --package=profiling --features=profile-with-tracy --example=simple
+
       - name: Build (type-check)
         run: cargo build --package=profiling --features=type-check
 
+      - name: Build (type-check example)
+        run: cargo build --package=profiling --features=type-check --example=simple
+
       # Only do this on windows, some of the profilers only support windows
       - name: Run tests
         if: ${{ runner.os == 'Windows' && matrix.toolchain == 'stable' }}

README.md

@@ -69,6 +69,8 @@ Currently, there's just six macros:
  * `profiling::scope!(name: &str, [tag: &str])`
      * name: scopes will appear in the profiler under this name
      * tag: optional extra data
+     * For maximum compatibility, you are **strongly** recommended to use literal strings for the name. Some backends require
+       static lifetime string references and some require literal strings.
  * `#[profiling::function]`
      * procmacro placed on a function to quickly wrap it in a scope using the function name
  * `#[profiling::all_functions]`

profiling/examples/simple.rs

@@ -50,8 +50,7 @@ fn some_other_function(iterations: usize) {
     burn_time(5);
 
     {
-        // Make this a non-literal to touch more of the API
-        profiling::scope!(&"do iterations".to_string());
+        profiling::scope!("do iterations");
         for i in 0..iterations {
             profiling::scope!(
                 "some_inner_function_that_sleeps",