From f335a990af20c7ddc9fca0439321db0c3c294df7 Mon Sep 17 00:00:00 2001 From: Bill Zissimopoulos Date: Sat, 18 Mar 2017 14:56:49 -0700 Subject: [PATCH] doc: add wiki home --- doc/Home.md | 31 +++++++++++++++++++++++++++++++ doc/WinFsp-Icon.png | Bin 0 -> 3904 bytes 2 files changed, 31 insertions(+) create mode 100644 doc/Home.md create mode 100644 doc/WinFsp-Icon.png diff --git a/doc/Home.md b/doc/Home.md new file mode 100644 index 00000000..9155d12a --- /dev/null +++ b/doc/Home.md @@ -0,0 +1,31 @@ +# WinFsp - Windows File System Proxy + +[[WinFsp-Icon.png]] + +Developing file systems is a challenging proposition. Developing file systems for Windows is an order of magnitude more difficult. WinFsp eases the task of writing a new file system for Windows. WinFsp file systems are user mode programs and they can be written in a variety of languages and frameworks. + +The documentation available here discusses various aspects of WinFsp. + +## Programming + +- The [[Tutorial|WinFsp-Tutorial]] describes how to create a simple, but complete file system in C/C++. +- The [[API Reference|winfsp.h]] describes the native WinFsp API. This external [[link|http://www.secfs.net/winfsp/apiref/]] may be easier to browse for some people. +- There is also a FUSE compatibility layer for native Windows and Cygwin. See fuse.h in the source repository. +- This [[document|Native-API-vs-FUSE]] discusses the need for both a native API and FUSE and gives some pointers on which one to choose. + +## Design + +- The [[Design|WinFsp-Design]] document describes the high-level design of WinFsp. +- The [[IPC|WinFsp-as-an-IPC-Mechanism]] document offers insights into the WinFsp Inter-Process Communication mechanism. +- The [[Service Architecture|WinFsp-Service-Architecture]] document discusses how to intergrate a file system into Windows as a service and the reasons to do so. + +## Testing + +- The [[Testing|WinFsp-Testing]] document discusses the WinFsp testing strategy and how WinFsp achieves correctness and stability. +- The [[Performance|WinFsp-Performance-Testing]] document compares WinFsp performance against other file systems. + +## Compatibility + +- The [[Compatibility|NTFS-Compatibility]] document discusses current WinFsp compatibility with NTFS. + +WinFsp is available under the GPLv3 license with a special exception for Free/Libre and Open Source Software. diff --git a/doc/WinFsp-Icon.png b/doc/WinFsp-Icon.png new file mode 100644 index 0000000000000000000000000000000000000000..a2655534fa65aa53cb5016d2a7372049cc016ac0 GIT binary patch literal 3904 zcmbtXXH*kPw@m;cRB6(Y5=0P52q3+8kSeIu(3>G4kN`o5v;ZR2D*{UIiqgC^B|ub) zQd9&22%&`{ML-awi4X3*@4ol_{${N+bLPyRz30qXYu1`1YfEERCIKb@0KjT$VsPzb zj6O9G{Yn2;%e@Z(0N(c3*S9v+*B7-84)pO4@CE>+?&C8oWDMN7d!l^q%1K|AN_LVo z)A!8G7M2Y6=Ml(k9>_<)hx=P7FZGmq-;m$Xk7w-B1xUE+NXN%#uE|OXE~|a)_akQ7 zE~$1bX)GN@d;n%!DGzwni(K=cU^=^tcwjr^xC};Beg9$Pu$aZn50<}Dz=`?vR`E?%$uA*p>sn=J&K1~Nz(#s(g9-KGIBSnc%XYC1} z4$DiY^>2?$uAWTWauk|;vv-LAagShlY|wgZm+K;ruh#|Ub0#OnU__fZU;qG~3#SG& zy(Y1FQW^(;JA16Xg}It%AQIy473kp&!6DHnXaGP1r*`5Zy|M11IAj0{qlVKI{|ljZ z;-7}0;-Y^+un0|Ydkbq({lH*v(JK%|h@7|xiqEhh6f7aafq76wxTT{|4`TmJh##hd54 zAMhorbcge3w~LmD2if~|9sy%zN_Ee07@#>=FY!@8dOSfF2$v1m`^6zbO0f_-_H(}G zXaF_C%ACf=BvwMQTl)Kc$S9^`Xoo!E64>EF33>J*rgEcNy>KZn0u|CR@(YgEHIvU^ zk)VCA^Ir}-EY4%LaTec{Mw%3jF?S> ziDoT!MQllIpW1hGEWa5H0>5(AQs^rqtXo|6sx~hGsoLpviT)nDD zcBQ+UPG2Xsn?DCC*xv4S5_%e$zbwr!S3HUk0!5XXS{#enmZS;KGW2S@=(Iph#(}g` zzt~qOR(x7zgRP692CuFnB0@@)5xWPuCFYjB(I1CLpMpF8q`qR2OORhTwP)D4HYFxX zG(02iBnJqZ(uE=q{ygltw1!JbAG%|)mog)0E8=;{Y`ITIB2|ziK)9lAhIiZ_W!~U9 z7Sqrz`k>d~clD-2>j3-cl;1=erLv*_0{mcg^Ah3U&>m-$H! zb*n~|_1~9oOsL)q7GhLcOO6*|R%X=ZMzh4-CS8#>2K5NB4WBv3n?$!ea9BXt{qP_- zplg-7wQel1-H<*Cvl3RLK=ZiPxsUuIN}=%a>+bBzxWX-EX2rC$;=V!V-b0_J4G-aQ zG|g5h{m;Z)snr_Kd{#q;%jur1kCrH(0|`z9DCjKn7+2b-?Ym=R8#h^5$1X@#R&dka zZl-q9-=h`WvsMegQwhIm-nQ8ObSK2D$#4ul|S^)<}p>`Vn`w*D0Vcl=~$+?-~;9Xm|z|a zz`mfJ1*vp~SR6=~t1#d95W^K-Saiwqr?8B1$n9M`qon~(=ejH*ptLml@15=g z!82MLuNip;p#u0c<7iw?yqnWHBU~b~ZV>0b@f84@Zg}sd$1>KwfyB-oy9I>>2rJO! zB>7i_Mvt1cWrHS#;PZNRp#}FcmtmwwA8VriKsVWJ=n3YprT|!FxGae;3n^b)<^Y5I zlKr|>lJw+uR%fE7$z#a@o$<8`;1E2Win;mYm`5@<*Wh|FAnAB6@yc)g_|l1{U$=^D zHrZ3pZ#PQ4K;<7(8F~dWk$)f$kpf}nJ6&WL%^rwvNUzz2S$)iGYIHt`rhO{G+BNib z$$TXLuj8qP*ZeJ>70;ig-+RW5u{F_S=50!PYN5X|)8RjR@+KMK;y3kX1%UpEd-g_x zUp^y)t%!zz`pCrhRS8FoyC?xOz;8W6p30zGUMEh!cNltD&~;Yxz^A5~ZO0@WVj12&lQtdFTXVN(r7BUmgKEF5 zIG4-`ycG&aAsZ4y=57vriLF0sMt5{2BcH5(0i91ylzv5M#O|!#Qcrkc$-wva%|T6! za1v)TQ!_K)(EVsNmR%R%_w@@OM=MY~dk^o2(vgDBv-^1lxu$n9=u4iB+b&v=IinTy z<8h{Nbq;v7&i+YQ{}R@aHd9XCckv z^pZYQBHj>4$WLd_Qe{HVgRmGU?__LaNJkAg9>&*)%==6>ezWoTaY`4L;)cnjW9NUX`KlD0vW zb72S=>KPC2T=yB9HBMraI|>-ecjsiYuI2=9KKs%lV|*h8P>!Y}kedi!go-wE*{q+a zT$kL!RmJR5R3RE*((als-B>|ubwpay4_Nhr0f8(8Jj&=617|PoI$9bW0|g@}3$qEd zH4B}#5zXIsWW6Y^%UQAs5j&IcZKQZwNG;@uz zwU=3NI6nWUx2IG;HV1u_<7JZUuOfslDET8_@;_&M2w z!22o$4tu&@t*>vRul0A`F7zpQK{j!g));sfv9fC1JXOA50Nu2+9`^p~Eyw%uH|*!g zfEU~rqq z0U*Q^CVN{<8qcmJMndwZNyVTTUyzO4XCJ(S}jiue!dazzk z@QbI{fjqq@Y;l`zpn1X_K07R`B~CTgKrT)YP7;N(xduZ;854 z$n=r(vI_TI=a)6);oG&5w{I{ZMyeW7ED5xAnDFT|H$QY<=k0?}*{}+)NG!A|?cVHy z$x~5O5=m<{1|aUYi79I zr)2=Z9>Q8cX%Ij;Uj(fi|(hEz+2O^X?!Df;R< z*xTerHaUH*#b?1phIhH7{XN|zfQ!f(t4H+Q%|ktVW)ercMq zBIWm)qs-pCiWTMOsbEwq@$nR5P*aVR3D!}p0_$cwJf(t67`}S=ihJ|5tVL&8VpM+H zy!#nb;D_rtVoB`1$L@7ylCd-H#KY*9a;1n;od}KNkwz20- zN-GX9>tY$p`e~BbM@Wp19}ou0X^Ak|eCGfbvy=@F=rn+vy1K`1yHB*dW#q6sy3u0L za*c%X^E0+lDi^1(EBtogun@>y7Zfh|iBk(BTaAGZg~tIo)U;1E!M%|QBH7(a1iaQjn|_N^T?6v#)|9k_ zoCz;~8^imA2=Aii0n1x<(*}7B)9}W^?_OG2Ni1#izYTd`M7ibyXik4uriPXVHF|Eb F{{u|hA5#DT literal 0 HcmV?d00001