Skip to content
This repository was archived by the owner on Mar 22, 2023. It is now read-only.

Commit 2d0c864

Browse files
Merge pull request #1054 from lukaszstolarczuk/fix-stage-docs
update docs
2 parents eca8f5f + 051c696 commit 2d0c864

3 files changed

Lines changed: 22 additions & 12 deletions

File tree

include/libpmemobj++/container/concurrent_hash_map.hpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1965,12 +1965,12 @@ class concurrent_hash_map
19651965
{
19661966
if (layout_features.incompat != header_features().incompat)
19671967
throw pmem::layout_error(
1968-
"Incompat flags mismatch, for more details go to: https://pmem.io/pmdk/cpp_obj/ \n");
1968+
"Incompat flags mismatch, for more details go to: https://pmem.io/libpmemobj-cpp\n");
19691969

19701970
if ((layout_features.compat & FEATURE_CONSISTENT_SIZE) &&
19711971
this->value_size != sizeof(value_type))
19721972
throw pmem::layout_error(
1973-
"Size of value_type is different than the one stored in the pool \n");
1973+
"Size of value_type is different than the one stored in the pool\n");
19741974
}
19751975

19761976
public:

include/libpmemobj++/pool.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -448,10 +448,14 @@ class pool_base {
448448
PMEMobjpool *pop;
449449

450450
#ifndef _WIN32
451-
/* Default create mode */
451+
/**
452+
* Default create mode
453+
*/
452454
static const int DEFAULT_MODE = S_IWUSR | S_IRUSR;
453455
#else
454-
/* Default create mode */
456+
/**
457+
* Default create mode
458+
*/
455459
static const int DEFAULT_MODE = S_IWRITE | S_IREAD;
456460
#endif
457461
};

include/libpmemobj++/transaction.hpp

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -443,16 +443,22 @@ class transaction_base {
443443
}
444444
}
445445

446-
/**
447-
* Possible stages of a transaction, for every stage one or more
448-
* callbacks can be registered.
446+
/*! \enum stage
447+
\brief Possible stages of a transaction.
448+
449+
For every stage one or more callbacks can be registered
450+
(see transaction::register_callback()).
451+
452+
To read more about PMDK's transactions and their stages, see
453+
manpage pmemobj_tx_begin(3):
454+
https://pmem.io/pmdk/manpages/linux/master/libpmemobj/pmemobj_tx_begin.3
449455
*/
450456
enum class stage {
451-
work = TX_STAGE_WORK, /* transaction in progress */
452-
oncommit = TX_STAGE_ONCOMMIT, /* successfully committed */
453-
onabort = TX_STAGE_ONABORT, /* tx_begin failed or transaction
454-
aborted */
455-
finally = TX_STAGE_FINALLY, /* ready for cleanup */
457+
work = TX_STAGE_WORK, /**< transaction in progress */
458+
oncommit = TX_STAGE_ONCOMMIT, /**< successfully committed */
459+
onabort = TX_STAGE_ONABORT, /**< tx_begin failed or transaction
460+
aborted */
461+
finally = TX_STAGE_FINALLY, /**< ready for cleanup */
456462
};
457463

458464
/**

0 commit comments

Comments
 (0)