database/pgbackrest
1
0
Fork 0
mirror of https://github.com/pgbackrest/pgbackrest.git synced 2025-08-01 06:46:52 +03:00
Code Activity

Fix documentation and comment typos.

Browse Source 
Identified using `ag -l | igor`.
This commit is contained in:
Eric Radman
2021-07-01 10:50:03 -05:00
committed by GitHub
parent 6a90d46909
commit 23bdc3deb6
17 changed files with 40 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/lib/pgBackRestDoc/Common/Doc.pm
View File

@ -356,7 +356,7 @@ sub nodeTest
####################################################################################################################################
# nodeAdd
#
# Add a node to to the current doc's child list
# Add a node to the current doc's child list
####################################################################################################################################
sub nodeAdd
{

2
doc/lib/pgBackRestDoc/Latex/DocLatex.pm
View File

@ -165,7 +165,7 @@ sub process
$strLatexOutputName = abs_path($self->{strLatexPath} . "/" . $oRender->{file});
}
# Copy pdf file if is is not already in the correct place
# Copy pdf file if it is not already in the correct place
if ($strLatexOutputName ne "$self->{strLatexPath}/" . $strLatexFileBase . '.pdf')
{
copy("$self->{strLatexPath}/" . $strLatexFileBase . '.pdf', $strLatexOutputName)

15
doc/xml/release.xml
View File

@ -50,6 +50,21 @@
</release-development-list>
</release-core-list>
<release-doc-list>
<release-improvement-list>
<release-item>
<github-pull-request id="1446"/>
<release-item-contributor-list>
<release-item-contributor id="eric.radman"/>
<release-item-reviewer id="david.steele"/>
</release-item-contributor-list>
<p>Fix documentation and comment typos.</p>
</release-item>
</release-improvement-list>
</release-doc-list>
<release-test-list>
<release-improvement-list>
<release-item>

2
doc/xml/user-guide.xml
View File

@ -2144,7 +2144,7 @@
</execute>
</execute-list>
<p>Now the the log output will contain the expected <quote>recovery stopping before...</quote> and <quote>last completed transaction...</quote> messages showing that the recovery was successful.</p>
<p>Now the log output will contain the expected <quote>recovery stopping before...</quote> and <quote>last completed transaction...</quote> messages showing that the recovery was successful.</p>
<execute-list host="{[host-pg1]}">
<title>Examine the <postgres/> log output for log messages indicating success</title>

6
src/command/backup/backup.c
View File

@ -380,9 +380,9 @@ backupBuildIncrPrior(const InfoBackup *infoBackup)
cfgOptCompressType, cfgSourceParam, VARSTR(compressTypeStr(manifestPriorData->backupOptionCompressType)));
// There's a small chance that the prior manifest is old enough that backupOptionCompressLevel was not recorded.
// There's an even smaller chance that the user will also alter compression-type in this this scenario right
// after upgrading to a newer version. Because we judge this combination of events to be nearly impossible just
// assert here so no test coverage is needed.
// There's an even smaller chance that the user will also alter compression-type in this scenario right after
// upgrading to a newer version. Because we judge this combination of events to be nearly impossible just assert
// here so no test coverage is needed.
CHECK(manifestPriorData->backupOptionCompressLevel != NULL);
// Set the compression level back to whatever was in the prior backup

4
src/command/expire/expire.c
View File

@ -478,7 +478,7 @@ removeExpiredArchive(InfoBackup *infoBackup, bool timeBasedFullRetention, unsign
}
// Loop through the archive.info history from oldest to newest and if there is a corresponding directory on disk
// then remove WAL that are not part of retention as long as the db:history id verion/system-id matches backup.info
// then remove WAL that are not part of retention as long as the db:history id version/system-id matches backup.info
for (unsigned int pgIdx = infoPgDataTotal(infoArchivePgData) - 1; (int)pgIdx >= 0; pgIdx--)
{
String *archiveId = infoPgArchiveId(infoArchivePgData, pgIdx);
@ -808,7 +808,7 @@ removeExpiredBackup(InfoBackup *infoBackup, const String *adhocBackupLabel, unsi
.expression = backupRegExpP(.full = true, .differential = true, .incremental = true)),
sortOrderDesc);
// Initialize the index to the lastest backup on disk
// Initialize the index to the latest backup on disk
unsigned int backupIdx = 0;
// Only remove the resumable backup if there is a possibility it is a dependent of the adhoc label being expired

2
src/command/info/info.c
View File

@ -106,7 +106,7 @@ typedef struct InfoRepoData
unsigned int key; // User-defined repo key
CipherType cipher; // Encryption type
const String *cipherPass; // Passphrase if the repo is encrypted (else NULL)
int stanzaStatus; // Status code of the the stanza on this repo
int stanzaStatus; // Status code of the stanza on this repo
unsigned int backupIdx; // Index of the next backup that may be a candidate for sorting
InfoBackup *backupInfo; // Contents of the backup.info file of the stanza on this repo
InfoArchive *archiveInfo; // Contents of the archive.info file of the stanza on this repo

2
src/command/repo/ls.c
View File

@ -45,7 +45,7 @@ storageListRenderCallback(void *data, const StorageInfo *info)
return;
}
// Add seperator character
// Add separator character
if (!listData->first && listData->json)
ioWrite(listData->write, COMMA_BUF);
else

10
src/command/verify/verify.c
View File

@ -265,7 +265,7 @@ verifyArchiveInfoFile(void)
VerifyInfoFile verifyArchiveInfoCopy = verifyInfoFile(
INFO_ARCHIVE_PATH_FILE_COPY_STR, false, cfgOptionStrNull(cfgOptRepoCipherPass));
// If the copy loaded successfuly, then check the checksums
// If the copy loaded successfully, then check the checksums
if (verifyArchiveInfoCopy.errorCode == 0)
{
// If the info and info.copy checksums don't match each other than one (or both) of the files could be corrupt so
@ -318,7 +318,7 @@ verifyBackupInfoFile(void)
VerifyInfoFile verifyBackupInfoCopy = verifyInfoFile(
INFO_BACKUP_PATH_FILE_COPY_STR, false, cfgOptionStrNull(cfgOptRepoCipherPass));
// If the copy loaded successfuly, then check the checksums
// If the copy loaded successfully, then check the checksums
if (verifyBackupInfoCopy.errorCode == 0)
{
// If the info and info.copy checksums don't match each other than one (or both) of the files could be corrupt so
@ -385,7 +385,7 @@ verifyManifestFile(
VerifyInfoFile verifyManifestInfoCopy = verifyInfoFile(
strNewFmt("%s%s", strZ(fileName), INFO_COPY_EXT), false, cipherPass);
// If the copy loaded successfuly, then check the checksums
// If the copy loaded successfully, then check the checksums
if (verifyManifestInfoCopy.errorCode == 0)
{
// If the manifest and manifest.copy checksums don't match each other than one (or both) of the files could be
@ -831,7 +831,7 @@ verifyBackup(void *data)
{
result = NULL;
// If result list is empty or the last processed is not equal to the backup being processed, then intialize the backup
// If result list is empty or the last processed is not equal to the backup being processed, then initialize the backup
// data and results
if (lstEmpty(jobData->backupResultList) ||
!strEq(((VerifyBackupResult *)lstGetLast(jobData->backupResultList))->backupLabel, strLstGet(jobData->backupList, 0)))
@ -1143,7 +1143,7 @@ verifySetBackupCheckArchive(
FUNCTION_TEST_PARAM(STRING_LIST, backupList); // List of backup labels in the backup directory
FUNCTION_TEST_PARAM(INFO_BACKUP, backupInfo); // Contents of the backup.info file
FUNCTION_TEST_PARAM(STRING_LIST, archiveIdList); // List of archiveIds in the archive directory
FUNCTION_TEST_PARAM(INFO_PG, pgHistory); // Pointer to InfoPg of archive.info for accesing PG history
FUNCTION_TEST_PARAM(INFO_PG, pgHistory); // Pointer to InfoPg of archive.info for accessing PG history
FUNCTION_TEST_PARAM_P(UINT, jobErrorTotal); // Pointer to overall job error total
FUNCTION_TEST_END();

2
src/common/compress/helper.h
View File

@ -45,7 +45,7 @@ CompressType compressTypeEnum(const String *type);
// Check that a valid compress type is compiled into this binary. Errors when the compress type is not present.
void compressTypePresent(CompressType type);
// Get string representation of a compression type. This is the the extension without the period.
// Get string representation of a compression type. This is the extension without the period.
const String *compressTypeStr(CompressType type);
// Get compression type from a (file) name by checking the extension. If the extension is not a supported compression type then

2
src/common/memContext.c
View File

@ -81,7 +81,7 @@ Memory context stack types
***********************************************************************************************************************************/
typedef enum
{
memContextStackTypeSwitch = 0, // Context can be switched to to allocate mem for new variables
memContextStackTypeSwitch = 0, // Context can be switched to allocate mem for new variables
memContextStackTypeNew, // Context to be tracked for error handling - cannot switch to
} MemContextStackType;

6
src/common/type/pack.c
View File

@ -16,7 +16,7 @@ is set) the base-128 encoded size and then by the string/binary bytes. For strin
is data, not the length of the data, which is why the length is stored immediately following the tag when the value bit is set. This
prevents storing an additional byte when the string/binary length is zero.
The following are definitions for the pack tag field and examples of how it is interpretted.
The following are definitions for the pack tag field and examples of how it is interpreted.
Integer types (packTypeMapData[type].valueMultiBit) when an unsigned value is <= 1 or a signed value is >= -1 and <= 0:
3 - more value indicator bit set to 0
@ -29,7 +29,7 @@ Integer types (packTypeMapData[type].valueMultiBit) when an unsigned value is <=
7 = tag byte low bits: 0 1 1 1 meaning:
"value low order bit" - the value of the u64 field is 1
"more ID delta indicator bit" - there exists a gap (i.e. NULLs are not stored so there is a gap between the stored IDs)
"ID delta low order bit" - gaps are interpretted as the currently stored ID minus previously stored ID minus 1, therefore if
"ID delta low order bit" - gaps are interpreted as the currently stored ID minus previously stored ID minus 1, therefore if
the previously store ID is 1 and the ID of this u64 field is 11 then a gap of 10 exists. 10 is represented internally as
9 since there is always at least a gap of 1 which never needs to be recorded (it is a given). 9 in bit format is
1 0 0 1 - the low-order bit is 1 so the "ID delta low order bit" is set.
@ -59,7 +59,7 @@ String, binary types, and boolean (packTypeMapData[type].valueSingleBit):
3 - value bit
2 - more ID delta indicator bit
0-1 - ID delta low order bits
Note: binary type is interpretted the same way as string type
Note: binary type is interpreted the same way as string type
Example: 8c090673616d706c65
8 = string type

2
src/common/type/string.h
View File

@ -123,7 +123,7 @@ String *strCatFmt(String *this, const char *format, ...) __attribute__((format(p
// N is <= the end of the string being concatenated.
String *strCatZN(String *this, const char *cat, size_t size);
// Return the index to the location of the the first occurrence of a character within a string, else -1
// Return the index to the location of the first occurrence of a character within a string, else -1
int strChr(const String *this, char chr);
// C-style string compare

2
src/config/load.c
View File

@ -210,7 +210,7 @@ cfgLoadUpdateOption(void)
{
// If repo-retention-archive-type is default (full), then if repo-retention-full is set, set the
// repo-retention-archive to this value when retention-full-type is 'count', else ignore archiving. If
// retention-full-type is 'time' then the the expire command will default the archive retention accordingly.
// retention-full-type is 'time' then the expire command will default the archive retention accordingly.
switch (archiveRetentionType)
{
case backupTypeFull:

2
src/info/manifest.c
View File

@ -1228,7 +1228,7 @@ manifestNewBuild(
lastRelationFileIdUnlogged = manifestFileFindDefault(this, relationInit, NULL) != NULL;
strFree(relationInit);
// Save the file id so we don't need to do the lookup next time if if doesn't change
// Save the file id so we don't need to do the lookup next time if it doesn't change
strcpy(lastRelationFileId, relationFileId);
}

2
test/lib/pgBackRestTest/Env/Host/HostBackupTest.pm
View File

@ -1340,7 +1340,7 @@ sub configCreate
$oParamHash{&CFGDEF_SECTION_GLOBAL}{'spool-path'} = $self->spoolPath();
# If the the backup host is remote
# If the backup host is remote
if (!$self->isHostBackup())
{
$oParamHash{&CFGDEF_SECTION_GLOBAL}{'repo1-host'} = $oHostBackup->nameGet();

2
test/src/test.c
View File

@ -1,7 +1,7 @@
/***********************************************************************************************************************************
C Test Wrapper
This wrapper runs the the C unit tests.
This wrapper runs the C unit tests.
***********************************************************************************************************************************/
#include "build.auto.h"