From a3d44d2fc2a40174b26b1050e563d680a9ad3b03 Mon Sep 17 00:00:00 2001 From: Joachim Wiberg Date: Tue, 19 Dec 2023 17:55:01 +0100 Subject: [PATCH] Use right-aligned API icon for doc link Signed-off-by: Joachim Wiberg --- README.md | 11 ++++------- doc/api.png | Bin 0 -> 6572 bytes 2 files changed, 4 insertions(+), 7 deletions(-) create mode 100644 doc/api.png diff --git a/README.md b/README.md index 23e5fbd..e701175 100644 --- a/README.md +++ b/README.md @@ -222,13 +222,12 @@ make sure the destination directory is writable if you change it. You can either inspect the file, or use the `watchdogctl` tool. +API + libwdog API ----------- -
- 🕮 API docs -
- To have `watchdogd` supervise a process, it must be instrumented with at least a "subscribe" and a "kick" API call. Commonly this is achieved by adding the `wdog_kick()` call to the main event loop. @@ -260,9 +259,7 @@ int wdog_kick2 (int id, unsigned int *ack); int wdog_extend_kick (int id, unsigned int timeout, unsigned int *ack); ``` -See [wdog.h](src/wdog.h) or -[codedocs.xyz](https://codedocs.xyz/troglobit/watchdogd/wdog_8h.html) -for detailed API documentation. +See [wdog.h](src/wdog.h) or 🕮 [codedocs.xyz](https://codedocs.xyz/troglobit/watchdogd/wdog_8h.html) for detailed API documentation. It is highly recommended to use an event loop like libev, [libuev][], or similar. For such libraries one can simply add a timer callback for the diff --git a/doc/api.png b/doc/api.png new file mode 100644 index 0000000000000000000000000000000000000000..a88f5a2b621c502bf1132d1c933b4d2328e9a465 GIT binary patch literal 6572 zcmb7J2{aVYzgAL~Y-I^$7a3b+C&iF0dt|3%l5Ol`$xzk^B}7DnQihodS!S4IH<+vokRwW)WRB(^C?y--asiFSe$Z_gBwuX!Lxm`5uZ39QimprVm49{Z4d0xt}8l2Mqd5$fW z+AS&9D_;7$p)4L7|Kn5Nmn*3Wa;Kcs6eP3k^ThSVsp;`NCgO?Gr@A-h|6;UnERMjJ z5K!bn_$ZdP8@mu=8h)Gz406nB;{s`7Y;cg5={;mPrG$wI#>`}JhAEMYiS-f_k2aHd z7}G5ZQ#}5}f3E)*r~fzLxTpV>;keg-XZtS<{|6v`IID!Iw=Zu-Hf%1StMJmpojhVF zXt%&kr!KbFh4s>V*DVc~ernyX_1yj)^@+}-qZXoJjYdDBEBuTcw^ZMN8VYOV*53s3 zsyw{;1Lq+^xb$9kE=sUQEI(kbYe1!NLFvGx2KOQLz$TH)n(Mm;YSMqS(o0MoHA3YS zJgB@vo9Z~A4_B4wk?Duaze+g!R=<1EB*WtWsNfWp=IbVX*Tq00Z-2zyk4t$QI}CVk z*FSKD&OLlQI*JC+Nt4TnQ8i|0A@-YOw9uS?HjKwnM+RlJC@RrZJJs#>4J=9Gt4bM;m zzDA57jJfu-QHL^{4W6n9L7f?k!s&p(g`8YA8+Q~**Xb}Kam<)@yu8)-i-;fz_Mg=` zup=li_1t6kpxr~28eqSJNfgeYrVFdIk;m4YzTac5)R}*)*fQ$yH5I4PHx~S=@*)Ye zlZ)5#t`m@AFq|4Xsd6>M!z0B-$B>_xfmz*|R1;Qw(U)NW0y;aoax7fA zhFg74DB*hXZeIOt&3R|)W`D6oR7v~ILHUms{Ra|Z@dFAzYjsd1v}Req`klss^PnTM zC=a#kem1+YhHgmc;abR3BHR?T0nIJ6z3tp937G}Flyu_(Uc8Yy;{A< z3wnLtJx;~YYf;J$5nBZjf_m*(fv0Zb&5O*V>VRU$g*?p*6kfPQyS>GLh!Ji zX=a~{?eh1iS?C`-JBW8}E{e?fa4(ts@p#k8$?be0W?D2I&VVYqGPl?D4xC`n5%)j_ zrqO#kEA49JuKsiNdWoagA1V)A@QMO(E2Sw7gf-;JKrIN#zoc!p(?t9O5syrXw; z-X7Q3MyDV7eYY7X*-a&`@4P!46%loJO4RG~v*#CQiAYY_^1p0Ia{YP+0+B(Z`d2^c zwI;5Ae9piaK0U6@janCSpb(V~*!`Gd-=0{|a`Ak2r1)rEAl6MD=0>9I{xD-V;P;FlsbDR50_&0rsjhNxczq`%4oF~5r83<^D8g)#h($de)m`TQ8SAdkkTZPkpO`$Nw3YTu;Kl-d?@sEF z7=hDVs_FPt3jFQ5y(nfLwPFfstFa8+zm?iKMmF>L05Czr+uc1Vj03p*XVkotLJ0CV zf6Z{;p(j$&kg^YJA?Sg~n|hi#S+@^buLD<19i`1Z<8-vudz7JM`QdYqL+jD`p0}y=OZz*U8=Qe zQ%T4zTknn!8D)TLhj!c57F0}l>(1`#1UGQyl|bF^-f+w?AkRn$#TnZ+bf-yXG&g&y z4I%M1==u);=k{PO$I&j&hslA=D6xRi5}}gfbi7VkeELU4#H+8|a!+r1?g+*);r5t4 z*IyK`q(d5lw0{nX|AIUGR<0^~_{Th?#t0B>bfI4=;8)O181#1$Vi9HOzPD9q@aOQQhRY;BpbZ`I6@Q zlrLipJ!DbgG)t$D^ETMKjWHmSsNlU^CM2T6Ic;zIfLxJP{EnCOM#OqSce`gKYnZ*5 zCJqbnM9^&{j))Iirx*mZ?%fN2=1kgZ&ZK-03QTa_tDB^*T!XG+VVgg*Ybin(a=(HP zD|i(36T7ieAsuc|0d3jOv#r9=m8G%hP-R);Wba|exe&j7O05l(;tV>b6Bk?kg0Uf4 zOA&tX`ArvsLQ#|uZhE@$#mR)6pvx`)D#%_sEl*5vNCS+Y+$#{hPFdjWnIZ zy=R8JRQmW_uc6>NNkZ7t?N40R+HzLFj}-?Yayy`e-+&-+*=8=}L3dncED}6eBdsOZ z)OcYk=NyX-W|qJ1a`6*CUwV$v;oBWy%oKez_zj&4(gBzQ^8bV>?Jc(rt-LMXRGP{c zJvWdAMm8vvv2CVW(pyPczzI^CZV z{nzaJ^4JFA_I>dSXN(L{U)8;QDH#&I`WSU-*%@8F(%k29BN;ers^@Si<2~!8wA9P# zv(1Wc1gbPIKXfttgOYG2eu9&_laC)~dQzb+?%u=gZ-gUpS74jPflk&eY639k5n0+~ zctBr}cLHs{!s(vW!uk4(H>Z7SezyN$?bPS(iIM0O1kPZsupIc0oUfZGEk{FC>GLQ_ z`nZIHxu;d(xSqES0BY@gJP2pYrQ0+s9Bw+=&B@5IwW%JpUf^743HW`HQc9>)m7Q*4 z)*M^95%|$aMvuR=C}L$L0<59*`MGk&<&ICtW`|4<^ZnJ=RY|moG%_FIQkue^F*WOs zsp?yDtSMzY?b`UXQIE>7u>UJa-#(zuKkno)X*wmB1`QM>BN)H9z-u=q-Uj4u67s#t zWilMaL!}x6K46K1E??g|-Ox~|x^tKc684dWM9%ee=XT?cT#WH6(h(IZp6L1ESE>q!3w45;eDz>6C*y7_~Z2I+VaWfilJnvxN&Nmg{|V;3?yuV?7(L$fa3 zYZc3nE6W|MMwdP~OEJI_Z{r7j=A;Fkuaw8MXTmq~e-pq07b8d@-He(iZg18oUw}qHuX{~BzoON{*az-4A&)Xd_6=_Nr^E8usT0XP^>?J)Z>z@ zDX&0J90w!_a5j?2T!WpgsGRbW7R{92hp91U-1$@f5lN`6-cZ69Qp(#fdJS*17Cu6c zUchM?X#vz2cU<#=9TtZe!TK@jdFErcSz`nk$;Z1xzx6A6%+u~e)$)o!Ddpfxkqb@c zt5@9jw51gXM#R=&O${h@-h}&;4e!NErDs2B6h2W-W0@3L0$WrGScjt23eEJJxhq(q zFLqIa(MPetCyWqgJ6*6}BBFXLyP8-4G%8LCt%fPj)kwzIpjKQ`#wSj2ucdkVaI?B0 z=8<;j^alKyX!70Nx}^F^7ug~><0nS2G-@PEz~nce0Um4XqdQJ|EeBmQ@~b;?ZZ8B< zi1eD2hniMDhxg!@4bc3xg#69!US+25WMADzp*Nl99J^=n;S5Szww4FpuNaM0?=fZaJIuV%jZVa= zUy*n-pbL9LGc7QvD42v)zUC|8!O_EU?S-5zd{u5kueozMt31po`kAu77W8N2F++W9 zMdFNE*^}O*>Yoq~1B^Q_l{@Dab<@^)YcxHqjC4j%LID-mWPQ6Z+ov`rJ=KA z8un<+&2_T<2^=laC%;B`PT5D*5V6&NW3ovwg5%LS(2$M3>D$UZ`YB#CHP%pZ(?!U^ zrH7-ult$y*(m`YoHAl8o`q|bxFc?dS>_+V4iY1|Uf~CY{C*xbQ)%|A&Uw+m-S?yHu zWG`SDZIz22%8pCIW4pN65cNYBY3%P7f-sA#sL8)evs`m|e%!P|_B}>eiAYSGu5@i0 zZTH!uJ$GisgEpm+7<4vV*Q-NbiEZ&Ubk?TGE5ZTpkfl#?Gp^n^eVtUkl zp&0*t|2cTBOaO{}#_rY@r&EF6aaHC$`1CR$_d?yDt|%GN1y0&7d?=IlqqK3kBL4?X z&P)7ssod&mw(7}hwaFl(Bybj6x$XV4^1mUIH^VHKs~c8uTiFW@fwy5tQql{+yOCp5 zEGV?n^+^XimqJ4KbJ!xcene_V}Sg16r>QinppYNF&fuz~;3hBTIWMD86%9==W zqM(uoYH+jPrmPp5E2rwr7RhdRj!(`&)O?)ZbQ%Gu*LLHKOqgOe{t4?35Q-2;kmc@MUcrC@b29d30BKAhK# zYT%H4{9fg=5W$7J)?6W24x@bJI=yfry|_ZY3eF%dM#&AYOOf6=x0Tc+n~Tv_SVUmT zMo)WQt&+H2jQ$q3dsn=!&EDOg%H}pR>dbC>{<;7kMdx0gcwYU+w)IaF`pC|eZOc~` zAId*Innbv}b7&~6U@O(KlyT+d&vir^2JBY398j1L{@jME3boMUg9n1Ox4HT5+N$pF z;dPRSnP3E?z{zra)VeXtr&ZrIXGjcLg>*#Ls*NZ~?+8~haJASc-=6J#b`_;RU!}I@ z*!p$u>4grxP<(!rcG~%m45>@(k`5xrZq5R*F)=j_h`Mku$=|QLe*Z=@*6TKjjEjYth`v4&w&1eocNzqH$yV5#1zl{@a)ISPq%cA_+xN{S|9ze?6 z71^kw1iVY4tpvnG6EQ7oaq~$-q2hrTNi2(lAr-jd!^#uAX=52Zgpf9q9304>>Nh9Q zbB&u-6m$y8kq{x(0lkC=to@*94hzsT7?6BkEQ$C|x$A9c~zv``x&xtfdl5C()DL&jS1J^Yy zXFq*0cf;SoqH!!uQR%wr2}29aN>+JV&qkg~8ML9ZE9(wVk?RgfDYQzL0sz+Pd(~Nw z-Yj_?)S~+$6j)mvS%h-l6IpVvD_f);-()G}Jkh+4e+=Tj8kJP1Jq%$M{lOe)WZ;&i z1N2&^oIvROhm8BrMAr8UkAW1ovV?EUEa!qteWGO3q5_k*T*wR1YuXltEp zFbz4+>ay>Wa~$mAK>;~VVE9r}AZs&wb%_Ib!8E`?Q~ryAd~IGh`r_F6CIO~cL6|aj zMhMC`S~_uBT{C`6BG@msHT-%J{dRX;!P*c9!=|SGdXYwJhb5e=I*4eTf64QE^zo1H z)eG*Dg#y)xeNh+SLW=#$(@J`3koZmNG7XiPAuMfKhW4fhwb4Ql@} zr(l3wCRKn2d{?r6Ydw2?;glG=Zta*a%x`J~Yfx*v-*v6!kwv|gwK|MRZV0L`*V@Tn zJ@5jhVK~8uEAPA2V@+7k=2>Z>D;Xehb0Ew$ms`ZA+2Y`>z?$p*pf@s1gT5n#7CbfW zR-g`_SVs~c&*4+zi*J)*Hka$ro)LM(jvOgD&GD@b6vz%6Hf%(EXj51IZO-y~%n&u7 z$7tq6+OvrI=I)i})^Ui_21tpWh5iAJLQsTts;y^=P3QY06MTKL9BpRYdTo8<8f$YC z4pF7WS$2is*tnW-1&lwbJ=unC>o_!X!kD-ipIKLqCvl|%PyWBP`F{>rko~uy!he_f tk0Jjv^6;-t{~Cq(r+{AE5t|Cr6`NB5i_E8|j>9cXrbd>A2m{Y&{{pvz1E~N2 literal 0 HcmV?d00001