srecord: versn_stamp.h Source File

srecord 1.65.0

Loading...
Searching...
No Matches
versn_stamp.h
Go to the documentation of this file.
1//
2// srecord - manipulate eprom load files
3// Copyright (C) 1998, 1999, 2002, 2006, 2007, 2010 Peter Miller
4//
5// This program is free software; you can redistribute it and/or modify
6// it under the terms of the GNU Lesser General Public License as
7// published by the Free Software Foundation; either version 3 of the
8// License, or (at your option) any later version.
9//
10// This program is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13// Lesser General Public License for more details.
14//
15// You should have received a copy of the GNU Lesser General
16// Public License along with this program. If not, see
17// <http://www.gnu.org/licenses/>.
18//
19
20#ifndef SRECORD_COMMON_VERSN_STAMP_H
21#define SRECORD_COMMON_VERSN_STAMP_H
22
23namespace srecord
24{
25
26/**
27 * The version_stamp function is used to obtain the version number,
28 * as a string. This reflects Aegis' idea of the version, so you can
29 * re-create that Aegis version easily.
30 */
31 const char *version_stamp(void);
32
33/**
34 * The copyright_years function is used to obtain the range of
35 * copyright years for the copyright notice. This reflects Aegis'
36 * tracking of the project, and updated automatically.
37 */
38 const char *copyright_years(void);
39
40/**
41 * The git_sha1 function is used to obtain the git hash as a string.
42 * This reflects git's idea of the version, so you can re-create that
43 * git version easily.
44 */
45 const char *git_sha1(void);
46
47/**
48 * The print_version function is used to print the program version, and
49 * brief copyright notice, to the standard output.
50 */
51 void print_version(void);
52
53};
54
55#endif // SRECORD_COMMON_VERSN_STAMP_H
srecord
Definition adler16.h:25
srecord::copyright_years
const char * copyright_years(void)
The copyright_years function is used to obtain the range of copyright years for the copyright notice.
srecord::git_sha1
const char * git_sha1(void)
The git_sha1 function is used to obtain the git hash as a string.
srecord::version_stamp
const char * version_stamp(void)
The version_stamp function is used to obtain the version number, as a string.
srecord::print_version
void print_version(void)
The print_version function is used to print the program version, and brief copyright notice,...