doc: use code snippets in sample app guides

[dpdk.git] / examples / timer / main.c

diff --git a/examples/timer/main.c b/examples/timer/main.c
index d270ce4..a349846 100644 (file)
--- a/examples/timer/main.c
+++ b/examples/timer/main.c
@@ -22,7 +22,7 @@ static uint64_t timer_resolution_cycles;
 static struct rte_timer timer0;
 static struct rte_timer timer1;
 
-/* timer0 callback */
+/* timer0 callback. 8< */
 static void
 timer0_cb(__rte_unused struct rte_timer *tim,
          __rte_unused void *arg)
@@ -37,8 +37,9 @@ timer0_cb(__rte_unused struct rte_timer *tim,
        if ((counter ++) == 20)
                rte_timer_stop(tim);
 }
+/* >8 End of timer0 callback. */
 
-/* timer1 callback */
+/* timer1 callback. 8< */
 static void
 timer1_cb(__rte_unused struct rte_timer *tim,
          __rte_unused void *arg)
@@ -53,6 +54,7 @@ timer1_cb(__rte_unused struct rte_timer *tim,
        lcore_id = rte_get_next_lcore(lcore_id, 0, 1);
        rte_timer_reset(tim, hz/3, SINGLE, lcore_id, timer1_cb, NULL);
 }
+/* >8 End of timer1 callback. */
 
 static __rte_noreturn int
 lcore_mainloop(__rte_unused void *arg)
@@ -63,6 +65,7 @@ lcore_mainloop(__rte_unused void *arg)
        lcore_id = rte_lcore_id();
        printf("Starting mainloop on core %u\n", lcore_id);
 
+       /* Main loop. 8< */
        while (1) {
                /*
                 * Call the timer handler on each core: as we don't need a
@@ -77,6 +80,7 @@ lcore_mainloop(__rte_unused void *arg)
                        prev_tsc = cur_tsc;
                }
        }
+       /* >8 End of main loop. */
 }
 
 int
@@ -86,22 +90,24 @@ main(int argc, char **argv)
        uint64_t hz;
        unsigned lcore_id;
 
-       /* init EAL */
+       /* Init EAL. 8< */
        ret = rte_eal_init(argc, argv);
        if (ret < 0)
                rte_panic("Cannot init EAL\n");
 
        /* init RTE timer library */
        rte_timer_subsystem_init();
+       /* >8 End of init EAL. */
 
-       /* init timer structures */
+       /* Init timer structures. 8< */
        rte_timer_init(&timer0);
        rte_timer_init(&timer1);
+       /* >8 End of init timer structures. */
 
+       /* Load timer0, every second, on main lcore, reloaded automatically. 8< */
        hz = rte_get_timer_hz();
        timer_resolution_cycles = hz * 10 / 1000; /* around 10ms */
 
-       /* load timer0, every second, on main lcore, reloaded automatically */
        lcore_id = rte_lcore_id();
        rte_timer_reset(&timer0, hz, PERIODICAL, lcore_id, timer0_cb, NULL);
 
@@ -109,13 +115,16 @@ main(int argc, char **argv)
        lcore_id = rte_get_next_lcore(lcore_id, 0, 1);
        rte_timer_reset(&timer1, hz/3, SINGLE, lcore_id, timer1_cb, NULL);
 
-       /* call lcore_mainloop() on every worker lcore */
+       /* >8 End of two timers configured. */
+
+       /* Call lcore_mainloop() on every worker lcore. 8< */
        RTE_LCORE_FOREACH_WORKER(lcore_id) {
                rte_eal_remote_launch(lcore_mainloop, NULL, lcore_id);
        }
 
        /* call it on main lcore too */
        (void) lcore_mainloop(NULL);
+       /* >8 End of call lcore_mainloop() on every worker lcore. */
 
        /* clean up the EAL */
        rte_eal_cleanup();