xeos
/
chrono
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
chrono/Makefile

67 lines
2.5 KiB
Makefile
Raw Normal View History

Better documentation and cross-references for naive types.
2016-07-31 16:02:32 +00:00
# this Makefile is mostly for the packaging convenience.
# casual users should use `cargo` to retrieve the appropriate version of Chrono.
0.2.0-dev: date/time parsing. Basically, this should close #12 when officially released. - Formatting syntax is now refactored out of the rendering logic. The main syntax is available in the `format::strftime` module, which also serves as a documentation for the syntax. - A parser (modelled after `strptime(3)`) has been implemented. See the individual commits for the detailed implementation. - There are two ways to get a timezone-aware value from a string: `Offset` or `DateTime<FixedOffset>`. The former should be used when the offset is known in advance (e.g. assume the local date) while the latter should be used when the offset is unknown. Naive types have a simple `from_str` method. - There are some known problems with the parser (even after tons of tests), which will be sorted out in 0.2. Known issues: - This does not exactly handle RFC 2822 and RFC 3339, which subtly differs from the current implementation in case-sensitivity, whitespace handling and legacy syntax. I'd like to integrate #24 for this cause. - Time zone names are not recognized at all. There is even no means to get a name itself, not sure about the resolution. - `Parsed` does *not* constrain `year` to be non-negative, so manually prepared `Parsed` may give a negative year. But the current verification pass may break such cases. - I absolutely don't know about the parser's performance! - `AUTHORS.txt` has been added, for what it's worth.
2015-02-04 17:37:54 +00:00
.PHONY: all
all:
@echo 'Try `cargo build` instead.'
.PHONY: authors
authors:
echo 'Chrono is mainly written by Kang Seonghoon <public+rust@mearie.org>,' > AUTHORS.txt
echo 'and also the following people (in ascending order):' >> AUTHORS.txt
echo >> AUTHORS.txt
git log --format='%aN <%aE>' | grep -v 'Kang Seonghoon' | sort -u >> AUTHORS.txt
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
.PHONY: readme
readme: README.md
README.md: src/lib.rs
# really, really sorry for this mess.
rustfmt'ed src/lib.rs (only).
2016-01-23 05:33:20 +00:00
awk '/^\/\/! # Chrono /{print "[Chrono][doc]",$$4}' $< > $@
awk '/^\/\/! # Chrono /{print "[Chrono][doc]",$$4}' $< | sed 's/./=/g' >> $@
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
echo >> $@
echo '[![Chrono on Travis CI][travis-image]][travis]' >> $@
Tweaked Travis settings and tried to enable Appveyor CI.
2016-08-16 18:05:09 +00:00
echo '[![Chrono on Appveyor][appveyor-image]][appveyor]' >> $@
echo '[![Chrono on crates.io][cratesio-image]][cratesio]' >> $@
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
echo >> $@
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
echo '[travis-image]: https://travis-ci.org/chronotope/chrono.svg?branch=master' >> $@
echo '[travis]: https://travis-ci.org/chronotope/chrono' >> $@
echo '[appveyor-image]: https://ci.appveyor.com/api/projects/status/2ia91ofww4w31m2w/branch/master?svg=true' >> $@
echo '[appveyor]: https://ci.appveyor.com/project/chronotope/chrono' >> $@
Tweaked Travis settings and tried to enable Appveyor CI.
2016-08-16 18:05:09 +00:00
echo '[cratesio-image]: https://img.shields.io/crates/v/chrono.svg' >> $@
echo '[cratesio]: https://crates.io/crates/chrono' >> $@
Documentation cleanup. - The main documentation (`src/lib.rs` AND `README.md`) now properly link to other types when rendered. - The role of `TimeZone` trait is explained more thoroughly. (Hopefully) fixes #82.
2016-07-25 18:45:53 +00:00
awk '/^\/\/! # Chrono /,/^\/\/! ## /' $< | cut -b 5- | grep -v '^#' | \
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
sed 's/](\.\//](https:\/\/docs.rs\/chrono\/'"$$(cargo pkgid | cut -d: -f3)"'\/chrono\//g' >> $@
Tweaked Travis settings and tried to enable Appveyor CI.
2016-08-16 18:05:09 +00:00
echo '***[Complete Documentation][doc]***' >> $@
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
echo >> $@
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
echo '[doc]: https://docs.rs/chrono/'"$$(cargo pkgid | cut -d: -f3)"'/' >> $@
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
echo >> $@
Documentation cleanup. - The main documentation (`src/lib.rs` AND `README.md`) now properly link to other types when rendered. - The role of `TimeZone` trait is explained more thoroughly. (Hopefully) fixes #82.
2016-07-25 18:45:53 +00:00
awk '/^\/\/! ## /,!/^\/\/!/' $< | cut -b 5- | grep -v '^# ' | \
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
sed 's/](\.\//](https:\/\/docs.rs\/chrono\/'"$$(cargo pkgid | cut -d: -f3)"'\/chrono\//g' >> $@
various doc cleanups; added `FromStr` impl for `DateTime<Local>`. also made a small script for auto-generating `README.md` out of the main doc comment from `src/lib.rs`.
2015-02-18 17:21:52 +00:00
Better documentation and cross-references for naive types.
2016-07-31 16:02:32 +00:00
.PHONY: test
test:
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
cargo test --features 'serde rustc-serialize bincode'
Better documentation and cross-references for naive types.
2016-07-31 16:02:32 +00:00
.PHONY: doc
doc: authors readme
Chrono is now under the Chronotope org; switch to docs.rs. All CI accounts are now moved to the new organization (unfortunately Appveyor does not automatically move the build history though). Since it's a mess to redirect everything to chronotope.github.io, I've taken this as an opportunity to switch to docs.rs---this seems to be better than the manual management nowadays. Updated other files as accordingly.
2017-02-05 20:49:32 +00:00
cargo doc --features 'serde rustc-serialize bincode'
Better documentation and cross-references for naive types.
2016-07-31 16:02:32 +00:00
.PHONY: doc-publish
doc-publish: doc
( \
PKGID="$$(cargo pkgid)"; \
PKGNAMEVER="$${PKGID#*#}"; \
PKGNAME="$${PKGNAMEVER%:*}"; \
REMOTE="$$(git config --get remote.origin.url)"; \
cd target/doc && \
rm -rf .git && \
git init && \
git checkout --orphan gh-pages && \
0.2.23: Documentation and minor bug fixes. - Tons of documentation updates! (#77, #78, #80, #82 and my own changes as well) - `DateTime::timestamp_subsec_{millis,micros,nanos}` methods have been added. (#81) - When the system time records a leap second, the nanosecond component was mistakenly reset to zero. (#84) - `Local` offset misbehaves in Windows for August and later, due to the long-standing libtime bug (dates back to mid-2015). Workaround has been implemented. (#85)
2016-08-02 16:18:33 +00:00
echo '<!doctype html><html><head><meta http-equiv="refresh" content="0;URL='$$PKGNAME'/index.html"></head><body></body></html>' > index.html && \
Better documentation and cross-references for naive types.
2016-07-31 16:02:32 +00:00
git add . && \
git commit -m 'updated docs.' && \
git push "$$REMOTE" gh-pages -f; \
)