Miroirs/cppannotations
1
0
Fork 0
mirror of https://gitlab.com/fbb-git/cppannotations synced 2024-11-16 07:48:44 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Annotations ready for GitHub

Browse source
This commit is contained in:
Frank B. Brokken 2015-08-21 16:00:17 +02:00
parent 1c7d5ba672
commit c97c01f044
10 changed files with 63 additions and 137 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README Normal file
View file

@ -0,0 +1,32 @@
The C++ Annotations offer an extensive tutorial about the C++ programming
language. It can be used as a textbook for C/C++ programming courses.
This document is intended for knowledgeable users of C (or any other language
using a C-like grammar, like Perl or Java) who would like to know more about,
or make the transition to, C++. This document is the main textbook for
Frank's C++ programming courses, which are yearly organized at the University
of Groningen, the Netherlands.
The C++ Annotations do not cover all aspects of C++, though. In particular,
C++'s basic grammar, which is, for all practical purposes, equal to C's
grammar, is not covered. For this part of the C++ language, the reader should
consult other texts, like a book covering the C programming language.
To create the various document formats from the C++ Annotations' sources,
either descend into the 'annotations' directory, or unpack a created archive, cd
into its top-level directory and follow the instructions provided in the
INSTALL file found there.
Alternatively, various binary ready-to-install packages of the C++ Annotations
are available in verious Linux distributions, in particular Debian. See, e.g.,
https://packages.debian.org/search?keywords=c%2B%2B-annotations&searchon=names&suite=all&section=all
Github's web-pages for the C++ Annotations are here:
https://fbb-git.github.io/cppannotations/
Zip archives containing the C++ Annotations in various formats can be
retrieved from
https://github.com/fbb-git/cppannotations-zip

6
annotations/build
View file

@ -20,6 +20,7 @@ string
#include "icmake/zips"
#include "icmake/examples"
#include "icmake/verify"
#include "icmake/github"
void main(int argc, list argv, list envp)
{
@ -78,6 +79,9 @@ void main(int argc, list argv, list envp)
exit(0);
}
if (option == "github")
github();
if (option == "install")
install(0, element(2, argv));
@ -113,6 +117,8 @@ void main(int argc, list argv, list envp)
" or undefined references in\n"
" tmp/docs/latex/cplusplus.log\n"
" zips - zip archives (after doc)\n"
" github - prepare github's gh-pages update\n"
" (internal use only)\n"
"\n"
);
exit(1);

7
annotations/icmake/github Normal file
View file

@ -0,0 +1,7 @@
void github()
{
run("cp -r yo/version.yo tmp/manhtml/c++-annotations-man.html "
"tmp/docs/zips ../../wip");
run("cp changelog ../../wip/changelog.txt");
exit(0);
}

4
annotations/icmake/man
View file

@ -1,11 +1,13 @@
void man()
{
md("tmp/man");
md("tmp/man tmp/manhtml");
if ("man/c++-annotations.yo" younger "tmp/man/c++-annotations.7")
{
chdir("man");
system("yodl2man -o ../tmp/man/c++-annotations.7 c++-annotations");
system("yodl2html -o ../tmp/manhtml/c++-annotations-man.html "
"c++-annotations");
chdir(g_cwd);
}
}

21
annotations/man/c++-annotations.yo
View file

@ -1,21 +1,27 @@
NOUSERMACRO(Annotations)
DEFINEMACRO(itb)(1)(it() bf(ARG1):nl())
DEFINEMACRO(itt)(1)(it() tt(ARG1))
includefile(../yo/version.yo)
htmlstyle(body)(color: #27408B; background: #FFFAF0)
whenhtml(mailto(Frank B. Brokken: f.b.brokken@rug.nl))
DELETEMACRO(tt)
DEFINEMACRO(tt)(1)(em(ARG1))
manpage(cpp-annotations)(7)(2006)(cpp-annotations.tar.gz)
manpage(C++ Annotations)(7)(YEARS)(cpp-annotations.DOCVERSION.tar.gz)
(C++ Annotations)
manpagename(cpp-annotations)(Frank Brokken's C++ Annotations)
manpagename(C++ Annotations)
(Extensive tutorial about the C++ programming language)
manpagedescription()
The bf(C++) Annotations offer an extensive tutorial about the bf(C++)
programming language. It can be used as a textbook for bf(C/C++) programming
courses. A translation of this document (included in this package) is
available in Portugese.
courses.
This document is intended for knowledgeable users of bf(C) (or any other
language using a bf(C)-like grammar, like bf(Perl) or bf(Java)) who would like
@ -44,7 +50,7 @@ paper-sizes: A4 and legal.
compressed forms (e.g., tt(cplusplus.txt.gz, cplusplus.html.zip)).
manpagefiles()
All files belonging to the bf(C++) Annotations are found at
All installed files (except for this man-page) are found at
tt(/usr/share/doc/cpp-annotations)
manpagesection(COPYRIGHT)
@ -53,3 +59,6 @@ manpagesection(COPYRIGHT)
manpageauthor()
Frank B. Brokken (bf(f.b.brokken@rug.nl)).

35
sf/README.upload
View file

@ -1,35 +0,0 @@
Uploading to sourceforge:
FIRST DO NEWRELEASE!!
Prepare a shell:
\ssh -t fbb,cppannotations@shell.sourceforge.net create
Run from ..
build docs
build zips
then cp the files from ~/debian/annotations/build-area:
README
c++-annotations-html_9.0.0-1_all.deb
c++-annotations_9.0.0.orig.tar.gz
to ~/svn/annotations/tmp/docs/zips
Then upload the above three files and the following files in the order
mentioned here:
README
c++-annotations-html_9.1.0-1_all.deb
c++-annotations_9.1.0.orig.tar.gz
cplusplus.yo.zip
cplusplus.txt.zip
cplusplus.ps.zip
cplusplus.pdf.zip
cplusplus.html.zip

BIN
sf/annotations.gif
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 4 KiB

BIN
sf/annotations.jpg
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 36 KiB

64
sf/index.yo
View file

@ -1,64 +0,0 @@
htmlbodyopt(text)(#27408B)
htmlbodyopt(bgcolor)(#FFFAF0)
includefile(../annotations/yo/version.yo)
COMMENT(Fill in the name of the program/package in these SUBSTs
And add the project info to the ../../PROJECTS.yo file)
SUBST(_pakx_)(cppannotations)
SUBST(_Pakx_)(C++ Annotations)
def(hr)(0)(htmlcommand(<hr>))
mailto(f.b.brokken@rug.nl)
affiliation(Center of Information Technology, University of Groningen)
notableofcontents()
report(_Pakx_ DOCVERSION)
(Frank B. Brokken (f.b.brokken@rug.nl)nl())
(YEARS)
COMMENT(
center(
htmlcommand(
<a href="http://sourceforge.net">
<img src="http://sourceforge.net/sflogo.php?group_id=127615&amp;type=2"
width="125" height="37" border="0" alt="SourceForge.net Logo" />
</a>)
)
END COMMENT)
This is the main page of the bf(_Pakx_) project as hosted on Sourceforge.net.
The project itself can be reached at
lurl(https://sourceforge.net/projects/_pakx_/)
htmlcommand(
<a href="http://sourceforge.net/projects/cppannotations"><img
src="http://sflogo.sourceforge.net/sflogo.php?group_id=255604&type=8"
width="80" height="15" border="0" alt="Get C++ Annotations at
SourceForge.net. Fast, secure and Free Open Source software downloads" /></a>
)
center(htmlcommand(<img src="annotations.jpg" alt="C++ Annotations">))
hr()
The Annotations are intended for people with a good knowledge of bf(C) who
want to make the transition to bf(C++).
hr()
htmlcommand(<font color=green>)
bf(Enjoy the _Pakx_ !!) The document starts url(here)(annotations/html/).
htmlcommand(</font>)
hr()
includefile(/home/frank/git/PROJECTS.yo)
Contact the author through url(his e-mail address)(mailto:f.b.brokken@rug.nl)

31
sf/newrelease
View file

@ -1,31 +0,0 @@
#!/bin/bash
cd ../annotations
./build distclean
./build programs
cd bin
./createhtml
./ziphtml
cd ../../sf
yodl2html index || exit 1
unzip ../annotations/zip/cplusplus.html.zip
scp -r index.html annotations \
fbb,cppannotations@web.sourceforge.net:htdocs/
rm -rf annotations
cd ../annotations
./build distclean