Comments (2)
Other things I've noticed;
- Currently
.gitattributes
marks*.in
files as binary so that test data using this extension doesn't get modified on Windows checkouts and break tests. Unfortunately this extension is also used for some cmake template files, includingdoc/Doxyfile.in
. Interestinglysrc/config.h.cmake
doesn't use.in
but it probably should since.cmake
indicates a cmake config file, not a template. We should rename the test data to use.input
instead, and renamesrc/config.h.cmake
tosrc/config.h.in
while we are at it. - In
doc/Doxyfile.in
there is a settingHAVE_DOT = NO
. This turns of all the nice diagrams that Doxygen can generate. Changing this to on makes the docs much more useful. There is alsoDOT_IMAGE_FORMAT = png
, and usingsvg
would probably be better. Also maybe interesting would beINTERACTIVE_SVG = YES
to add interactive zoom/pan. Note this requires gaphviz to be installed, so we should update the GitHub action to install it. - There are many files missing the basic
\file <foo>.h
Doxygen docstring which means they are omitted from the docs. Adding at least all the headers would make navigating the include diagrams much nicer. - Some functions are documented in the
*.h
file, and some in the*.c
file. We should put documentation in the*.h
file when we can.
from librsync.
After playing around with markdown docs and github actions in #230 I think maybe replacing \ref
links with markdown links may be premature. It seems the version of Doxygen on the github actions ubuntu_latest
target suffers from doxygen/doxygen#7595 so markdown links don't quite work as advertised.
There are still several things here that need fixing, so I'm going to put together a PR with the bits still worth doing.
from librsync.
Related Issues (20)
- Migrate from Travis to GitHub Actions. HOT 1
- Supplying rdiff Base File Using Pipe Results in Illegal Seek Error in librsync HOT 8
- Generate signature from empty basis HOT 2
- Replace popt with something better supported. HOT 3
- popt not found on Pop_OS Hirsute
- rsync vs network speed HOT 9
- rs_patch_file old <-> new file HOT 1
- 1) sig file -> size 0 ? 2) static/dynamic lib Windows ? HOT 6
- Runtime error when linking to rsync MSVC compiled with MT or MTd ? HOT 2
- Determine delta size before generation (streaming api) HOT 2
- build 2.3.2 with msvs 2019 failed HOT 2
- [Feature Request] Implement FastCDC? HOT 7
- Request: Add windows build to stable release HOT 2
- v2.3.3 tests are failing only on s390x HOT 4
- rdiff v2.3.4 I/O error on Linux Mint HOT 6
- rdiff v2.3.4 popt.dll error on Windows HOT 10
- Suggestion: have static binary for windows users HOT 2
- Migration to GitHub is not complete HOT 1
- Support for MacOS universal2 architecture ? HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from librsync.