Skip to content

Commit c4ce978

Browse files
adamygadamyg
committed
doc
1 parent 054d138 commit c4ce978

15 files changed

+82
-72
lines changed

‎README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -164,16 +164,19 @@ Working examples are provided as test applications. For following demonstrates o
164164
#include "libappupdater/update/updatetoolshim.h" // UpdaterToolShim()
165165

166166
#include "version.h" // VERSION_TAG, build-system version.
167-
#include "private_key.h" // PUBLIC_KEY and KEY_VERSION, see: keygen
167+
#include "public_key.h" // PUBLIC_KEY and KEY_VERSION, see: keygen
168168

169169
int
170170
main(int argc, char *argv[])
171171
{
172172
struct UpdateToolArgs args = {0};
173173

174-
args.title = "MyApplication updater";
174+
args.progtitle = "MyApplication updater";
175+
176+
args.appname = "MyApplication";
175177
args.version = VERSION_TAG;
176178
args.hosturl = "https://github.com/user/repo~application.manifest";
179+
177180
args.publickey = PUBLIC_KEY;
178181
args.keyversion = KEY_VERSION;
179182

@@ -187,7 +190,7 @@ main(int argc, char *argv[])
187190
#include "libappupdater/src/AutoUpdater.h" // AutoUpdater
188191
189192
#include "version.h" // VERSION_TAG, build-system version.
190-
#include "private_key.h" // PUBLIC_KEY and KEY_VERSION, see: keygen
193+
#include "public_key.h" // PUBLIC_KEY and KEY_VERSION, see: keygen
191194
192195
int
193196
Application::CheckForUpdates()
@@ -200,8 +203,10 @@ Application::CheckForUpdates()
200203
// see AutoConfig.h for further details.
201204
//
202205
au.EnableDialog();
203-
au.AppName("Application Name");
206+
207+
au.AppName("MyApplication");
204208
au.AppVersion(VERSION_TAG);
209+
205210
au.HostURL("https://github.com/user/repo~application.manifest");
206211
au.PublicKey(PUBLIC_KEY, KEY_VERSION);
207212

‎msvc/CAutoUpdater.vs140.vcxproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,28 @@
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
2929
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
3030
<ConfigurationType>Application</ConfigurationType>
31-
<PlatformToolset>v142</PlatformToolset>
31+
<PlatformToolset>v140</PlatformToolset>
3232
<UseOfMfc>Dynamic</UseOfMfc>
3333
<CharacterSet>Unicode</CharacterSet>
3434
<WholeProgramOptimization>true</WholeProgramOptimization>
3535
</PropertyGroup>
3636
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
3737
<ConfigurationType>Application</ConfigurationType>
38-
<PlatformToolset>v142</PlatformToolset>
38+
<PlatformToolset>v140</PlatformToolset>
3939
<UseOfMfc>Dynamic</UseOfMfc>
4040
<CharacterSet>Unicode</CharacterSet>
4141
<WholeProgramOptimization>true</WholeProgramOptimization>
4242
</PropertyGroup>
4343
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
4444
<ConfigurationType>Application</ConfigurationType>
45-
<PlatformToolset>v142</PlatformToolset>
45+
<PlatformToolset>v140</PlatformToolset>
4646
<UseOfMfc>Dynamic</UseOfMfc>
4747
<UseOfAtl>false</UseOfAtl>
4848
<CharacterSet>Unicode</CharacterSet>
4949
</PropertyGroup>
5050
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
5151
<ConfigurationType>Application</ConfigurationType>
52-
<PlatformToolset>v142</PlatformToolset>
52+
<PlatformToolset>v140</PlatformToolset>
5353
<UseOfMfc>Dynamic</UseOfMfc>
5454
<UseOfAtl>false</UseOfAtl>
5555
<CharacterSet>Unicode</CharacterSet>

‎msvc/KeyGen.vs140.vcxproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,28 @@
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
2929
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
3030
<ConfigurationType>Application</ConfigurationType>
31-
<PlatformToolset>v142</PlatformToolset>
31+
<PlatformToolset>v140</PlatformToolset>
3232
<UseOfMfc>false</UseOfMfc>
3333
<CharacterSet>Unicode</CharacterSet>
3434
<WholeProgramOptimization>true</WholeProgramOptimization>
3535
</PropertyGroup>
3636
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
3737
<ConfigurationType>Application</ConfigurationType>
38-
<PlatformToolset>v142</PlatformToolset>
38+
<PlatformToolset>v140</PlatformToolset>
3939
<UseOfMfc>false</UseOfMfc>
4040
<CharacterSet>Unicode</CharacterSet>
4141
<WholeProgramOptimization>true</WholeProgramOptimization>
4242
</PropertyGroup>
4343
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
4444
<ConfigurationType>Application</ConfigurationType>
45-
<PlatformToolset>v142</PlatformToolset>
45+
<PlatformToolset>v140</PlatformToolset>
4646
<UseOfMfc>false</UseOfMfc>
4747
<UseOfAtl>false</UseOfAtl>
4848
<CharacterSet>Unicode</CharacterSet>
4949
</PropertyGroup>
5050
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
5151
<ConfigurationType>Application</ConfigurationType>
52-
<PlatformToolset>v142</PlatformToolset>
52+
<PlatformToolset>v140</PlatformToolset>
5353
<UseOfMfc>false</UseOfMfc>
5454
<UseOfAtl>false</UseOfAtl>
5555
<CharacterSet>Unicode</CharacterSet>

‎msvc/NSRes.vs140.vcxproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,28 @@
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
2929
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
3030
<ConfigurationType>Application</ConfigurationType>
31-
<PlatformToolset>v142</PlatformToolset>
31+
<PlatformToolset>v140</PlatformToolset>
3232
<UseOfMfc>false</UseOfMfc>
3333
<CharacterSet>Unicode</CharacterSet>
3434
<WholeProgramOptimization>true</WholeProgramOptimization>
3535
</PropertyGroup>
3636
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
3737
<ConfigurationType>Application</ConfigurationType>
38-
<PlatformToolset>v142</PlatformToolset>
38+
<PlatformToolset>v140</PlatformToolset>
3939
<UseOfMfc>false</UseOfMfc>
4040
<CharacterSet>Unicode</CharacterSet>
4141
<WholeProgramOptimization>true</WholeProgramOptimization>
4242
</PropertyGroup>
4343
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
4444
<ConfigurationType>Application</ConfigurationType>
45-
<PlatformToolset>v142</PlatformToolset>
45+
<PlatformToolset>v140</PlatformToolset>
4646
<UseOfMfc>false</UseOfMfc>
4747
<UseOfAtl>false</UseOfAtl>
4848
<CharacterSet>Unicode</CharacterSet>
4949
</PropertyGroup>
5050
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
5151
<ConfigurationType>Application</ConfigurationType>
52-
<PlatformToolset>v142</PlatformToolset>
52+
<PlatformToolset>v140</PlatformToolset>
5353
<UseOfMfc>false</UseOfMfc>
5454
<UseOfAtl>false</UseOfAtl>
5555
<CharacterSet>Unicode</CharacterSet>

‎msvc/NSRes.vs140.vcxproj.filters

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
<ClCompile Include="..\util\upgetopt.cpp">
4141
<Filter>Source Files</Filter>
4242
</ClCompile>
43-
<ClCompile Include="..\localisation\NSRes.cpp">
43+
<ClCompile Include="..\localisation\util\NSRes.cpp">
4444
<Filter>Source Files</Filter>
4545
</ClCompile>
4646
</ItemGroup>

‎msvc/SignTool.vs140.vcxproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,28 @@
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
2929
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
3030
<ConfigurationType>Application</ConfigurationType>
31-
<PlatformToolset>v142</PlatformToolset>
31+
<PlatformToolset>v140</PlatformToolset>
3232
<UseOfMfc>false</UseOfMfc>
3333
<CharacterSet>Unicode</CharacterSet>
3434
<WholeProgramOptimization>true</WholeProgramOptimization>
3535
</PropertyGroup>
3636
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
3737
<ConfigurationType>Application</ConfigurationType>
38-
<PlatformToolset>v142</PlatformToolset>
38+
<PlatformToolset>v140</PlatformToolset>
3939
<UseOfMfc>false</UseOfMfc>
4040
<CharacterSet>Unicode</CharacterSet>
4141
<WholeProgramOptimization>true</WholeProgramOptimization>
4242
</PropertyGroup>
4343
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
4444
<ConfigurationType>Application</ConfigurationType>
45-
<PlatformToolset>v142</PlatformToolset>
45+
<PlatformToolset>v140</PlatformToolset>
4646
<UseOfMfc>false</UseOfMfc>
4747
<UseOfAtl>false</UseOfAtl>
4848
<CharacterSet>Unicode</CharacterSet>
4949
</PropertyGroup>
5050
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
5151
<ConfigurationType>Application</ConfigurationType>
52-
<PlatformToolset>v142</PlatformToolset>
52+
<PlatformToolset>v140</PlatformToolset>
5353
<UseOfMfc>false</UseOfMfc>
5454
<UseOfAtl>false</UseOfAtl>
5555
<CharacterSet>Unicode</CharacterSet>

‎msvc/TAutoUpdater.vs140.vcxproj

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,28 +28,28 @@
2828
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
2929
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
3030
<ConfigurationType>Application</ConfigurationType>
31-
<PlatformToolset>v142</PlatformToolset>
31+
<PlatformToolset>v140</PlatformToolset>
3232
<UseOfMfc>false</UseOfMfc>
3333
<CharacterSet>Unicode</CharacterSet>
3434
<WholeProgramOptimization>true</WholeProgramOptimization>
3535
</PropertyGroup>
3636
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
3737
<ConfigurationType>Application</ConfigurationType>
38-
<PlatformToolset>v142</PlatformToolset>
38+
<PlatformToolset>v140</PlatformToolset>
3939
<UseOfMfc>false</UseOfMfc>
4040
<CharacterSet>Unicode</CharacterSet>
4141
<WholeProgramOptimization>true</WholeProgramOptimization>
4242
</PropertyGroup>
4343
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
4444
<ConfigurationType>Application</ConfigurationType>
45-
<PlatformToolset>v142</PlatformToolset>
45+
<PlatformToolset>v140</PlatformToolset>
4646
<UseOfMfc>false</UseOfMfc>
4747
<UseOfAtl>false</UseOfAtl>
4848
<CharacterSet>Unicode</CharacterSet>
4949
</PropertyGroup>
5050
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
5151
<ConfigurationType>Application</ConfigurationType>
52-
<PlatformToolset>v142</PlatformToolset>
52+
<PlatformToolset>v140</PlatformToolset>
5353
<UseOfMfc>false</UseOfMfc>
5454
<UseOfAtl>false</UseOfAtl>
5555
<CharacterSet>Unicode</CharacterSet>

‎msvc/libappupdater.vs140.vcxproj

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -133,33 +133,33 @@
133133
<ProjectGuid>{EBA010B5-F14F-4AED-9E6B-D519BACD1615}</ProjectGuid>
134134
<RootNamespace>AutoUpdater</RootNamespace>
135135
<Keyword>Win32Proj</Keyword>
136-
<WindowsTargetPlatformVersion>10.0</WindowsTargetPlatformVersion>
136+
<WindowsTargetPlatformVersion>8.1</WindowsTargetPlatformVersion>
137137
<ProjectName>libappupdater</ProjectName>
138138
</PropertyGroup>
139139
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
140140
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|Win32'" Label="Configuration">
141141
<ConfigurationType>DynamicLibrary</ConfigurationType>
142-
<PlatformToolset>v142</PlatformToolset>
142+
<PlatformToolset>v140</PlatformToolset>
143143
<CharacterSet>Unicode</CharacterSet>
144144
<WholeProgramOptimization>true</WholeProgramOptimization>
145145
<UseOfMfc>false</UseOfMfc>
146146
</PropertyGroup>
147147
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x64'" Label="Configuration">
148148
<ConfigurationType>DynamicLibrary</ConfigurationType>
149-
<PlatformToolset>v142</PlatformToolset>
149+
<PlatformToolset>v140</PlatformToolset>
150150
<CharacterSet>Unicode</CharacterSet>
151151
<WholeProgramOptimization>true</WholeProgramOptimization>
152152
<UseOfMfc>false</UseOfMfc>
153153
</PropertyGroup>
154154
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|Win32'" Label="Configuration">
155155
<ConfigurationType>DynamicLibrary</ConfigurationType>
156-
<PlatformToolset>v142</PlatformToolset>
156+
<PlatformToolset>v140</PlatformToolset>
157157
<CharacterSet>Unicode</CharacterSet>
158158
<UseOfMfc>false</UseOfMfc>
159159
</PropertyGroup>
160160
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x64'" Label="Configuration">
161161
<ConfigurationType>DynamicLibrary</ConfigurationType>
162-
<PlatformToolset>v142</PlatformToolset>
162+
<PlatformToolset>v140</PlatformToolset>
163163
<CharacterSet>Unicode</CharacterSet>
164164
<UseOfMfc>false</UseOfMfc>
165165
</PropertyGroup>

‎sign/signtool.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// $Id: signtool.cpp,v 1.3 2025/04/22 08:08:52 cvsuser Exp $
1+
// $Id: signtool.cpp,v 1.4 2025/04/22 17:24:04 cvsuser Exp $
22
//
33
// AutoUpdater: Manifest generation tool.
44
//
@@ -34,7 +34,7 @@ main(int argc, char *argv[])
3434
{
3535
struct SignToolArgs args = {0};
3636

37-
args.appname = "signtool";
37+
args.progname = "signtool";
3838

3939
return SignToolShim(argc, argv, &args);
4040
}

‎sign/signtoolshim.cpp

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// $Id: signtoolshim.cpp,v 1.4 2025/04/22 08:08:52 cvsuser Exp $
1+
// $Id: signtoolshim.cpp,v 1.5 2025/04/22 17:24:04 cvsuser Exp $
22
//
33
// AutoUpdater: Manifest generation tool.
44
//
@@ -69,7 +69,7 @@ SignToolShim(int argc, char *argv[], const struct SignToolArgs *args)
6969
int ch;
7070

7171
// arguments
72-
progname = (args->appname ? args->appname : Updater::Util::Basename(argv[0]));
72+
progname = (args->progname ? args->progname : Updater::Util::Basename(argv[0]));
7373
while (-1 != (ch = Updater::Getopt(argc, argv, options))) {
7474
switch (ch) {
7575
case 'H': // host URL template
@@ -193,14 +193,14 @@ SignToolShim(int argc, char *argv[], const struct SignToolArgs *args)
193193
static void
194194
Usage(const struct SignToolArgs &args)
195195
{
196-
const char *apptitle =
197-
(args.apptitle && *args.apptitle ? args.apptitle : "AutoUpdater manifest generator");
196+
const char *progtitle =
197+
(args.progtitle && *args.progtitle ? args.progtitle : "AutoUpdater manifest generator");
198198

199199
std::cout.flush();
200200
std::cerr <<
201201
"\n"\
202-
<< apptitle << ".\n"\
203-
"Engine Version (" << autoupdate_version_string() << ")\n" \
202+
<< progtitle << ".\n"\
203+
"Engine Version (" << autoupdate_version_string() << ")\n"\
204204
"\n"\
205205
" " << progname << " [options] <input> [<output>]\n"\
206206
"\n"\
@@ -210,15 +210,15 @@ Usage(const struct SignToolArgs &args)
210210
"\n";
211211

212212
std::cerr <<
213-
" -H <host-url> Explicit source URL" \
213+
" -H <host-url> Explicit source URL"\
214214
", default <" << (args.hosturl ? args.hosturl : "none") << ">.\n";
215215

216216
if (args.hosturlalt)
217217
std::cerr <<
218218
" -A alternative source URL <" << args.hosturlalt << ">.\n";
219219

220220
std::cerr <<
221-
" -K <private-key> Private key image, generates a ed25519 signature.\n"\
221+
" -K <private-key> Private key image, generates a Ed25519 signature.\n"\
222222
" -x <version> KeyVersion, default <1>.\n"\
223223
"\n"\
224224
"Arguments:\n"\

‎sign/signtoolshim.h

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#ifndef SIGNTOOLSHIM_H_INCLUDED
22
#define SIGNTOOLSHIM_H_INCLUDED
3-
// $Id: signtoolshim.h,v 1.3 2025/04/22 08:08:52 cvsuser Exp $
3+
// $Id: signtoolshim.h,v 1.4 2025/04/22 17:24:04 cvsuser Exp $
44
//
55
// AutoUpdater: sign-tool
66
//
@@ -32,11 +32,13 @@ extern "C" {
3232
#endif
3333

3434
struct SignToolArgs {
35-
const char *appname;
36-
const char *apptitle;
37-
const char *version;
38-
const char *hosturl;
39-
const char *hosturlalt;
35+
const char *progname; // sign-tool program name; default argv.
36+
const char *progtitle; // program usage title line.
37+
38+
const char *version; // application version; x.x.x.x
39+
40+
const char *hosturl; // manifest URL.
41+
const char *hosturlalt; // alternative manifest URL.
4042
};
4143

4244
extern int SignToolShim(int argc, char *argv[], const struct SignToolArgs *args);

‎src/AutoConfig.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#ifndef AUTOCONFIG_H_INCLUDED
22
#define AUTOCONFIG_H_INCLUDED
3-
// $Id: AutoConfig.h,v 1.19 2025/04/22 05:30:36 cvsuser Exp $
3+
// $Id: AutoConfig.h,v 1.20 2025/04/22 17:25:25 cvsuser Exp $
44
//
55
// AutoUpdater: configuration management.
66
//
@@ -229,4 +229,4 @@ class Config {
229229

230230
} // namespace Updater
231231

232-
#endif //AUTOSETTINGS_H_INCLUDED
232+
#endif //AUTOSETTINGS_H_INCLUDED

‎update/updatetool.cpp

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// $Id: updatetool.cpp,v 1.3 2025/04/22 08:18:36 cvsuser Exp $
1+
// $Id: updatetool.cpp,v 1.4 2025/04/22 17:23:55 cvsuser Exp $
22
//
33
// AutoUpdater: update-tool - example
44
//
@@ -43,9 +43,9 @@ main(int argc, char *argv[])
4343
{
4444
struct UpdateToolArgs args = {0};
4545

46-
args.appname = "updatetool";
46+
args.progname = "updatetool";
4747

48-
args.productname = "libautoupdate";
48+
args.appname = "libautoupdate";
4949
// ags.version = "0.0.0.0";
5050

5151
// args.hosturl = hosturl1;

0 commit comments

Comments
 (0)