Skip to content

Commit 3e0f8ff

Browse files
author
blep
committed
- fixed typos and added "download" section to documentation
- commit version numbers after release git-svn-id: https://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/jsoncpp@134 1f120ed1-78a5-a849-adca-83f0a9e25bb6
1 parent 782c524 commit 3e0f8ff

File tree

2 files changed

+37
-9
lines changed

2 files changed

+37
-9
lines changed

doc/jsoncpp.dox

+24-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<a HREF="http://www.json.org/">JSON (JavaScript Object Notation)</a>
66
is a lightweight data-interchange format.
7-
It can represents integer, real number, string, an ordered sequence of value, and
7+
It can represent integer, real number, string, an ordered sequence of value, and
88
a collection of name/value pairs.
99

1010
Here is an example of JSON data:
@@ -28,8 +28,16 @@ Here is an example of JSON data:
2828

2929
\section _features Features
3030
- read and write JSON document
31+
- attach C and C++ style comments to element during parsing
3132
- rewrite JSON document preserving original comments
3233

34+
Notes: Comments used to be supported in JSON but where removed for
35+
portability (C like comments are not supported in Python). Since
36+
comments are useful in configuration/input file, this feature was
37+
preserved.
38+
39+
\section _example Code example
40+
3341
\code
3442
Json::Value root; // will contains the root value after parsing.
3543
Json::Reader reader;
@@ -57,7 +65,7 @@ setIndentUseSpace( root["indent"].get("use_space", true).asBool() );
5765
// ...
5866
// At application shutdown to make the new configuration document:
5967
// Since Json::Value has implicit constructor for all value types, it is not
60-
// necessary to explicitely construct the Json::Value object:
68+
// necessary to explicitly construct the Json::Value object:
6169
root["encoding"] = getCurrentEncoding();
6270
root["indent"]["length"] = getCurrentIndentLength();
6371
root["indent"]["use_space"] = getCurrentIndentUseSpace();
@@ -75,11 +83,22 @@ std::cout << root;
7583
\endcode
7684

7785
\section _plinks Build instructions
78-
The build instruction are located in the file
86+
The build instructions are located in the file
7987
<a HREF="README.txt">README.txt</a> in the top-directory of the project.
8088

81-
Permanent link to the lastest revision of the file in subversion:
82-
<a HREF="http://svn.sourceforge.net/viewcvs.cgi/jsoncpp/README.txt?view=markup">lastest README.txt</a>
89+
Permanent link to the latest revision of the file in subversion:
90+
<a HREF="http://svn.sourceforge.net/viewcvs.cgi/jsoncpp/README.txt?view=markup">latest README.txt</a>
91+
92+
\section _pdownload Download
93+
The sources can be downloaded from
94+
<a HREF="http://sourceforge.net/projects/jsoncpp/files/">SourceForge download page</a>.
95+
96+
The latest version of the source is available in the project's subversion repository:
97+
<a HREF="http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/">
98+
http://jsoncpp.svn.sourceforge.net/svnroot/jsoncpp/trunk/</a>
99+
100+
To checkout the source, see the following
101+
<a HREF="http://sourceforge.net/scm/?type=svn&group_id=144446">instructions</a>.
83102

84103
\section _plinks Project links
85104
- <a HREF="http://jsoncpp.sourceforge.net">json-cpp home</a>

makerelease.py

+13-4
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ def check_no_pending_commit():
5858
for entry in etree.getiterator( 'entry' ):
5959
path = entry.get('path')
6060
status = entry.find('wc-status').get('item')
61-
if status != 'unversioned':
61+
if status != 'unversioned' and path != 'version':
6262
msg.append( 'File "%s" has pending change (status="%s")' % (path, status) )
6363
if msg:
6464
msg.insert(0, 'Pending change to commit found in sandbox. Commit them first!' )
@@ -84,6 +84,11 @@ def svn_check_if_tag_exist( tag_url ):
8484
return False
8585
return True
8686

87+
def svn_commit( message ):
88+
"""Commit the sandbox, providing the specified comment.
89+
"""
90+
svn_command( 'ci', '-m', message )
91+
8792
def svn_tag_sandbox( tag_url, message ):
8893
"""Makes a tag based on the sandbox revisions.
8994
"""
@@ -272,9 +277,10 @@ def main():
272277
parser.enable_interspersed_args()
273278
options, args = parser.parse_args()
274279

275-
if len(args) < 1:
280+
if len(args) != 2:
276281
parser.error( 'release_version missing on command-line.' )
277282
release_version = args[0]
283+
next_version = args[1]
278284

279285
if not options.platforms and not options.no_test:
280286
parser.error( 'You must specify either --platform or --no-test option.' )
@@ -286,6 +292,7 @@ def main():
286292
if not msg:
287293
print 'Setting version to', release_version
288294
set_version( release_version )
295+
svn_commit( 'Release ' + release_version )
289296
tag_url = svn_join_url( SVN_TAG_ROOT, release_version )
290297
if svn_check_if_tag_exist( tag_url ):
291298
if options.retag_release:
@@ -350,8 +357,10 @@ def main():
350357
else:
351358
print 'No upload user specified. Web site and download tarbal were not uploaded.'
352359
print 'Tarball can be found at:', doc_tarball_path
353-
#@todo:
354-
#upload source & doc tarballs
360+
361+
# Set next version number and commit
362+
set_version( next_version )
363+
svn_commit( 'Released ' + release_version )
355364
else:
356365
sys.stderr.write( msg + '\n' )
357366

0 commit comments

Comments
 (0)