From 20cc39d443d1a2c364b0fb778c7813ae7b5a1dd6 Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Tue, 11 Dec 2018 17:42:39 +0100 Subject: Add "since" attributes in xml for new functions and modules introduced after OTP_R13B03. --- lib/mnesia/doc/src/mnesia.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'lib/mnesia') diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 621b6047ee..5f11b55ab9 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -595,7 +595,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - change_table_majority(Tab, Majority) -> {aborted, R} | {atomic, ok} + change_table_majority(Tab, Majority) -> {aborted, R} | {atomic, ok} Changes the majority check setting for the table.

Majority must be a boolean. Default is false. @@ -2143,7 +2143,7 @@ mnesia:create_table(employee, - sync_log() -> ok | {error, Reason} + sync_log() -> ok | {error, Reason} Performs a file sync of the local log file.

Ensures that the local transaction log file is synced to disk. -- cgit v1.2.3 From 50f64c60b87e8d03fedc3f9f4e655aff8ca9f16c Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:32:24 +0100 Subject: Add empty 'since' attribute for old modules and functions --- lib/mnesia/doc/src/mnesia.xml | 224 ++++++++++++++++---------------- lib/mnesia/doc/src/mnesia_frag_hash.xml | 12 +- lib/mnesia/doc/src/mnesia_registry.xml | 6 +- 3 files changed, 121 insertions(+), 121 deletions(-) (limited to 'lib/mnesia') diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 5f11b55ab9..921721d4b7 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -32,7 +32,7 @@ - mnesia + mnesia A distributed telecommunications DBMS @@ -183,7 +183,7 @@ - abort(Reason) -> transaction abort + abort(Reason) -> transaction abort Terminates the current transaction.

Makes the transaction silently @@ -195,7 +195,7 @@ - activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} + activate_checkpoint(Args) -> {ok,Name,Nodes} | {error,Reason} Activates a checkpoint. @@ -259,7 +259,7 @@ - activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun [, Args]) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -271,7 +271,7 @@ - activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) + activity(AccessContext, Fun, Args, AccessMod) -> ResultOfFun | exit(Reason) Executes Fun in AccessContext. @@ -403,7 +403,7 @@ - add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} + add_table_copy(Tab, Node, Type) -> {aborted, R} | {atomic, ok} Copies a table to a remote node. @@ -420,7 +420,7 @@ mnesia:add_table_copy(person, Node, disc_copies) - add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + add_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Creates an index for a table. @@ -441,7 +441,7 @@ mnesia:add_table_index(person, age) - all_keys(Tab) -> KeyList | transaction abort + all_keys(Tab) -> KeyList | transaction abort Returns all keys in a table. @@ -453,7 +453,7 @@ mnesia:add_table_index(person, age) - async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + async_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -493,7 +493,7 @@ mnesia:add_table_index(person, age) - backup(Opaque [, BackupMod]) -> ok | {error,Reason} + backup(Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in the database. @@ -505,7 +505,7 @@ mnesia:add_table_index(person, age) - backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} + backup_checkpoint(Name, Opaque [, BackupMod]) -> ok | {error,Reason} Backs up all tables in a checkpoint. @@ -520,7 +520,7 @@ mnesia:add_table_index(person, age) - change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} + change_config(Config, Value) -> {error, Reason} | {ok, ReturnValue} Changes a configuration parameter. @@ -554,7 +554,7 @@ mnesia:add_table_index(person, age) - change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} + change_table_access_mode(Tab, AccessMode) -> {aborted, R} | {atomic, ok} Changes the access mode for the table. @@ -568,7 +568,7 @@ mnesia:add_table_index(person, age) - change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} + change_table_copy_type(Tab, Node, To) -> {aborted, R} | {atomic, ok} Changes the storage type of a table. @@ -585,7 +585,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} + change_table_load_order(Tab, LoadOrder) -> {aborted, R} | {atomic, ok} Changes the load order priority for the table. @@ -607,7 +607,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - clear_table(Tab) -> {aborted, R} | {atomic, ok} + clear_table(Tab) -> {aborted, R} | {atomic, ok} Deletes all entries in a table. @@ -615,7 +615,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_schema(DiscNodes) -> ok | {error,Reason} + create_schema(DiscNodes) -> ok | {error,Reason} Creates a new schema on the specified nodes. @@ -637,7 +637,7 @@ mnesia:change_table_copy_type(person, node(), disc_copies) - create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} + create_table(Name, TabDef) -> {atomic, ok} | {aborted, Reason} Creates a Mnesia table called Namewith properties as described by argument TabDef. @@ -799,7 +799,7 @@ mnesia:create_table(person, - deactivate_checkpoint(Name) -> ok | {error, Reason} + deactivate_checkpoint(Name) -> ok | {error, Reason} Deactivates a checkpoint. @@ -811,7 +811,7 @@ mnesia:create_table(person, - del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} + del_table_copy(Tab, Node) -> {aborted, R} | {atomic, ok} Deletes the replica of table Tab at node Node. @@ -825,7 +825,7 @@ mnesia:create_table(person, - del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} + del_table_index(Tab, AttrName) -> {aborted, R} | {atomic, ok} Deletes an index in a table. @@ -834,7 +834,7 @@ mnesia:create_table(person, - delete({Tab, Key}) -> transaction abort | ok + delete({Tab, Key}) -> transaction abort | ok Deletes all records in table Tab with the key Key. @@ -842,7 +842,7 @@ mnesia:create_table(person, - delete(Tab, Key, LockKind) -> transaction abort | ok + delete(Tab, Key, LockKind) -> transaction abort | ok Deletes all records in table Tabwith the key Key. @@ -857,7 +857,7 @@ mnesia:create_table(person, - delete_object(Record) -> transaction abort | ok + delete_object(Record) -> transaction abort | ok Delete a record. @@ -866,7 +866,7 @@ mnesia:create_table(person, - delete_object(Tab, Record, LockKind) -> transaction abort | ok + delete_object(Tab, Record, LockKind) -> transaction abort | ok Deletes a record. @@ -883,7 +883,7 @@ mnesia:create_table(person, - delete_schema(DiscNodes) -> ok | {error,Reason} + delete_schema(DiscNodes) -> ok | {error,Reason} Deletes the schema on the given nodes. @@ -904,7 +904,7 @@ mnesia:create_table(person, - delete_table(Tab) -> {aborted, Reason} | {atomic, ok} + delete_table(Tab) -> {aborted, Reason} | {atomic, ok} Deletes permanently all replicas of table Tab. @@ -912,7 +912,7 @@ mnesia:create_table(person, - dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) + dirty_all_keys(Tab) -> KeyList | exit({aborted, Reason}) Dirty search for all record keys in table. @@ -920,7 +920,7 @@ mnesia:create_table(person, - dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) + dirty_delete({Tab, Key}) -> ok | exit({aborted, Reason}) Dirty delete of a record. @@ -928,14 +928,14 @@ mnesia:create_table(person, - dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) + dirty_delete(Tab, Key) -> ok | exit({aborted, Reason}) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete/3.

- dirty_delete_object(Record) + dirty_delete_object(Record) Dirty delete of a record. @@ -944,14 +944,14 @@ mnesia:create_table(person, - dirty_delete_object(Tab, Record) + dirty_delete_object(Tab, Record) Dirty delete of a record.

Dirty equivalent of the function mnesia:delete_object/3.

- dirty_first(Tab) -> Key | exit({aborted, Reason}) + dirty_first(Tab) -> Key | exit({aborted, Reason}) Returns the key for the first record in a table. @@ -967,7 +967,7 @@ mnesia:create_table(person, - dirty_index_match_object(Pattern, Pos) + dirty_index_match_object(Pattern, Pos) Dirty pattern match using index. @@ -977,7 +977,7 @@ mnesia:create_table(person, - dirty_index_match_object(Tab, Pattern, Pos) + dirty_index_match_object(Tab, Pattern, Pos) Dirty pattern match using index.

Dirty equivalent of the function @@ -985,7 +985,7 @@ mnesia:create_table(person, - dirty_index_read(Tab, SecondaryKey, Pos) + dirty_index_read(Tab, SecondaryKey, Pos) Dirty read using index. @@ -994,7 +994,7 @@ mnesia:create_table(person, - dirty_last(Tab) -> Key | exit({aborted, Reason}) + dirty_last(Tab) -> Key | exit({aborted, Reason}) Returns the key for the last record in a table. @@ -1006,7 +1006,7 @@ mnesia:create_table(person, - dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern. @@ -1015,7 +1015,7 @@ mnesia:create_table(person, - dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) + dirty_match_object(Tab, Pattern) -> RecordList | exit({aborted, Reason}) Dirty pattern match pattern.

Dirty equivalent of the function @@ -1023,7 +1023,7 @@ mnesia:create_table(person, - dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_next(Tab, Key) -> Key | exit({aborted, Reason}) Return the next key in a table. @@ -1038,7 +1038,7 @@ mnesia:create_table(person, - dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) + dirty_prev(Tab, Key) -> Key | exit({aborted, Reason}) Returns the previous key in a table. @@ -1050,7 +1050,7 @@ mnesia:create_table(person, - dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} + dirty_read({Tab, Key}) -> ValueList | exit({aborted, Reason} Dirty read of records. @@ -1058,14 +1058,14 @@ mnesia:create_table(person, - dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} + dirty_read(Tab, Key) -> ValueList | exit({aborted, Reason} Dirty read of records.

Dirty equivalent of the function mnesia:read/3.

- dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} + dirty_select(Tab, MatchSpec) -> ValueList | exit({aborted, Reason} Dirty matches the objects in Tab against MatchSpec. @@ -1073,7 +1073,7 @@ mnesia:create_table(person, - dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) + dirty_slot(Tab, Slot) -> RecordList | exit({aborted, Reason}) Returns the list of records that are associated with Slot in a table. @@ -1089,7 +1089,7 @@ mnesia:create_table(person, - dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter({Tab, Key}, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record. @@ -1097,7 +1097,7 @@ mnesia:create_table(person, - dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) + dirty_update_counter(Tab, Key, Incr) -> NewVal | exit({aborted, Reason}) Dirty update of a counter record.

Mnesia has no special counter records. However, @@ -1126,7 +1126,7 @@ mnesia:create_table(person, - dirty_write(Record) -> ok | exit({aborted, Reason}) + dirty_write(Record) -> ok | exit({aborted, Reason}) Dirty write of a record. @@ -1135,14 +1135,14 @@ mnesia:create_table(person, - dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) + dirty_write(Tab, Record) -> ok | exit({aborted, Reason}) Dirty write of a record.

Dirty equivalent of the function mnesia:write/3.

- dump_log() -> dumped + dump_log() -> dumped Performs a user-initiated dump of the local log file. @@ -1156,7 +1156,7 @@ mnesia:create_table(person, - dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} + dump_tables(TabList) -> {atomic, ok} | {aborted, Reason} Dumps all RAM tables to disc. @@ -1168,7 +1168,7 @@ mnesia:create_table(person, - dump_to_textfile(Filename) + dump_to_textfile(Filename) Dumps local tables into a text file. @@ -1181,7 +1181,7 @@ mnesia:create_table(person, - error_description(Error) -> String + error_description(Error) -> String Returns a string describing a particular Mnesia error. @@ -1259,7 +1259,7 @@ mnesia:create_table(person, - ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) + ets(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a raw context that is not protected by a transaction. @@ -1278,7 +1278,7 @@ mnesia:create_table(person, - first(Tab) -> Key | transaction abort + first(Tab) -> Key | transaction abort Returns the key for the first record in a table. @@ -1293,7 +1293,7 @@ mnesia:create_table(person, - foldl(Function, Acc, Table) -> NewAcc | transaction abort + foldl(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1306,7 +1306,7 @@ mnesia:create_table(person, - foldr(Function, Acc, Table) -> NewAcc | transaction abort + foldr(Function, Acc, Table) -> NewAcc | transaction abort Calls Function for each record in Table. @@ -1317,7 +1317,7 @@ mnesia:create_table(person, - force_load_table(Tab) -> yes | ErrorDescription + force_load_table(Tab) -> yes | ErrorDescription Forces a table to be loaded into the system. @@ -1335,7 +1335,7 @@ mnesia:create_table(person, - index_match_object(Pattern, Pos) -> transaction abort | ObjList + index_match_object(Pattern, Pos) -> transaction abort | ObjList Matches records and uses index information. @@ -1345,7 +1345,7 @@ mnesia:create_table(person, - index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList + index_match_object(Tab, Pattern, Pos, LockKind) -> transaction abort | ObjList Matches records and uses index information. @@ -1377,7 +1377,7 @@ mnesia:create_table(person, - index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList + index_read(Tab, SecondaryKey, Pos) -> transaction abort | RecordList Reads records through index table. @@ -1397,7 +1397,7 @@ mnesia:create_table(person, - info() -> ok + info() -> ok Prints system information on the terminal. @@ -1408,7 +1408,7 @@ mnesia:create_table(person, - install_fallback(Opaque) -> ok | {error,Reason} + install_fallback(Opaque) -> ok | {error,Reason} Installs a backup as fallback. @@ -1417,7 +1417,7 @@ mnesia:create_table(person, - install_fallback(Opaque), BackupMod) -> ok | {error,Reason} + install_fallback(Opaque), BackupMod) -> ok | {error,Reason} Installs a backup as fallback.

Calls mnesia:install_fallback(Opaque, Args), where @@ -1425,7 +1425,7 @@ mnesia:create_table(person, - install_fallback(Opaque, Args) -> ok | {error,Reason} + install_fallback(Opaque, Args) -> ok | {error,Reason} Installs a backup as fallback.

Installs a backup as fallback. The fallback is used to @@ -1483,7 +1483,7 @@ mnesia:create_table(person, - is_transaction() -> boolean + is_transaction() -> boolean Checks if code is running in a transaction. @@ -1492,7 +1492,7 @@ mnesia:create_table(person, - last(Tab) -> Key | transaction abort + last(Tab) -> Key | transaction abort Returns the key for the last record in a table.

Works exactly like @@ -1503,7 +1503,7 @@ mnesia:create_table(person, - load_textfile(Filename) + load_textfile(Filename) Loads tables from a text file. @@ -1516,7 +1516,7 @@ mnesia:create_table(person, - lock(LockItem, LockKind) -> Nodes | ok | transaction abort + lock(LockItem, LockKind) -> Nodes | ok | transaction abort Explicit grab lock. @@ -1605,7 +1605,7 @@ mnesia:create_table(person, - match_object(Pattern) -> transaction abort | RecList + match_object(Pattern) -> transaction abort | RecList Matches Pattern for records. @@ -1614,7 +1614,7 @@ mnesia:create_table(person, - match_object(Tab, Pattern, LockKind) -> transaction abort | RecList + match_object(Tab, Pattern, LockKind) -> transaction abort | RecList Matches Pattern for records. @@ -1639,7 +1639,7 @@ mnesia:create_table(person, - move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} + move_table_copy(Tab, From, To) -> {aborted, Reason} | {atomic, ok} Moves the copy of table Tab from node From to node To. @@ -1653,7 +1653,7 @@ mnesia:create_table(person, - next(Tab, Key) -> Key | transaction abort + next(Tab, Key) -> Key | transaction abort Returns the next key in a table. @@ -1665,7 +1665,7 @@ mnesia:create_table(person, - prev(Tab, Key) -> Key | transaction abort + prev(Tab, Key) -> Key | transaction abort Returns the previous key in a table.

Works exactly like @@ -1676,7 +1676,7 @@ mnesia:create_table(person, - read({Tab, Key}) -> transaction abort | RecordList + read({Tab, Key}) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1684,14 +1684,14 @@ mnesia:create_table(person, - read(Tab, Key) -> transaction abort | RecordList + read(Tab, Key) -> transaction abort | RecordList Reads records(s) with a given key.

Calls function mnesia:read(Tab, Key, read).

- read(Tab, Key, LockKind) -> transaction abort | RecordList + read(Tab, Key, LockKind) -> transaction abort | RecordList Reads records(s) with a given key. @@ -1716,7 +1716,7 @@ mnesia:create_table(person, - read_lock_table(Tab) -> ok | transaction abort + read_lock_table(Tab) -> ok | transaction abort Sets a read lock on an entire table. @@ -1725,7 +1725,7 @@ mnesia:create_table(person, - report_event(Event) -> ok + report_event(Event) -> ok Reports a user event to the Mnesia event handler. @@ -1743,7 +1743,7 @@ mnesia:create_table(person, - restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} + restore(Opaque, Args) -> {atomic, RestoredTabs} |{aborted, Reason} Online restore of backup. @@ -1803,7 +1803,7 @@ mnesia:create_table(person, - s_delete({Tab, Key}) -> ok | transaction abort + s_delete({Tab, Key}) -> ok | transaction abort Sets sticky lock and delete records. @@ -1812,7 +1812,7 @@ mnesia:create_table(person, - s_delete_object(Record) -> ok | transaction abort + s_delete_object(Record) -> ok | transaction abort Sets sticky lock and delete record. @@ -1822,7 +1822,7 @@ mnesia:create_table(person, - s_write(Record) -> ok | transaction abort + s_write(Record) -> ok | transaction abort Writes Record and sets sticky lock. @@ -1832,21 +1832,21 @@ mnesia:create_table(person, - schema() -> ok + schema() -> ok Prints information about all table definitions on the terminal.

Prints information about all table definitions on the terminal.

- schema(Tab) -> ok + schema(Tab) -> ok Prints information about one table definition on the terminal.

Prints information about one table definition on the terminal.

- select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] + select(Tab, MatchSpec [, Lock]) -> transaction abort | [Object] Matches the objects in Tab against MatchSpec. @@ -1884,7 +1884,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Tab, MatchSpec, NObjects, Lock) -> transaction abort | {[Object],Cont} | '$end_of_table' Matches the objects in Tab against MatchSpec. @@ -1907,7 +1907,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' + select(Cont) -> transaction abort | {[Object],Cont} | '$end_of_table' Continues selecting objects.

Selects more objects with the match specification initiated @@ -1919,7 +1919,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_debug_level(Level) -> OldLevel + set_debug_level(Level) -> OldLevel Changes the internal debug level of Mnesia. @@ -1930,7 +1930,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(MasterNodes) -> ok | {error, Reason} + set_master_nodes(MasterNodes) -> ok | {error, Reason} Sets the master nodes for all tables. @@ -1943,7 +1943,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} + set_master_nodes(Tab, MasterNodes) -> ok | {error, Reason} Sets the master nodes for a table. @@ -1968,14 +1968,14 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} + snmp_close_table(Tab) -> {aborted, R} | {atomic, ok} Removes the possibility for SNMP to manipulate the table.

Removes the possibility for SNMP to manipulate the table.

- snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined + snmp_get_mnesia_key(Tab, RowIndex) -> {ok, Key} | undefined Gets the corresponding Mnesia key from an SNMP index. Tab ::= atom() @@ -1990,7 +1990,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable + snmp_get_next_index(Tab, RowIndex) -> {ok, NextIndex} | endOfTable Gets the index of the next lexicographical row. Tab ::= atom() @@ -2006,7 +2006,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined + snmp_get_row(Tab, RowIndex) -> {ok, Row} | undefined Retrieves a row indexed by an SNMP index. Tab ::= atom() @@ -2019,7 +2019,7 @@ mnesia:select(Tab,[{MatchHead, [Guard], [Result]}]), - snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} + snmp_open_table(Tab, SnmpStruct) -> {aborted, R} | {atomic, ok} Organizes a Mnesia table as an SNMP table. Tab ::= atom() @@ -2073,7 +2073,7 @@ mnesia:create_table(employee, - start() -> ok | {error, Reason} + start() -> ok | {error, Reason} Starts a local Mnesia system. @@ -2108,7 +2108,7 @@ mnesia:create_table(employee, - stop() -> stopped + stop() -> stopped Stops Mnesia locally. @@ -2117,7 +2117,7 @@ mnesia:create_table(employee, - subscribe(EventCategory) -> {ok, Node} | {error, Reason} + subscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2127,7 +2127,7 @@ mnesia:create_table(employee, - sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) + sync_dirty(Fun, [, Args]) -> ResultOfFun | exit(Reason) Calls the Fun in a context that is not protected by a transaction. @@ -2166,7 +2166,7 @@ mnesia:create_table(employee, - system_info(InfoKey) -> Info | exit({aborted, Reason}) + system_info(InfoKey) -> Info | exit({aborted, Reason}) Returns information about the Mnesia system. @@ -2408,7 +2408,7 @@ mnesia:create_table(employee, - table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) + table_info(Tab, InfoKey) -> Info | exit({aborted, Reason}) Returns local information about table. @@ -2628,7 +2628,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList, NewRecordName) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab. @@ -2649,7 +2649,7 @@ raise(Name, Amount) -> - transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} + transform_table(Tab, Fun, NewAttributeList) -> {aborted, R} | {atomic, ok} Changes format on all records in table Tab.

Calls mnesia:transform_table(Tab, Fun, @@ -2689,7 +2689,7 @@ raise(Name, Amount) -> - uninstall_fallback() -> ok | {error,Reason} + uninstall_fallback() -> ok | {error,Reason} Uninstalls a fallback. @@ -2698,7 +2698,7 @@ raise(Name, Amount) -> - uninstall_fallback(Args) -> ok | {error,Reason} + uninstall_fallback(Args) -> ok | {error,Reason} Uninstalls a fallback.

Deinstalls a fallback before it @@ -2725,7 +2725,7 @@ raise(Name, Amount) -> - unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} + unsubscribe(EventCategory) -> {ok, Node} | {error, Reason} Subscribes to events of type EventCategory. @@ -2735,7 +2735,7 @@ raise(Name, Amount) -> - wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} + wait_for_tables(TabList, Timeout) -> ok | {timeout, BadTabList} | {error, Reason} Waits for tables to be accessible. @@ -2746,7 +2746,7 @@ raise(Name, Amount) -> - wread({Tab, Key}) -> transaction abort | RecordList + wread({Tab, Key}) -> transaction abort | RecordList Reads records with given key. @@ -2754,7 +2754,7 @@ raise(Name, Amount) -> - write(Record) -> transaction abort | ok + write(Record) -> transaction abort | ok Writes a record into the database. @@ -2763,7 +2763,7 @@ raise(Name, Amount) -> - write(Tab, Record, LockKind) -> transaction abort | ok + write(Tab, Record, LockKind) -> transaction abort | ok Writes a record into the database. @@ -2779,7 +2779,7 @@ raise(Name, Amount) -> - write_lock_table(Tab) -> ok | transaction abort + write_lock_table(Tab) -> ok | transaction abort Sets write lock on an entire table. diff --git a/lib/mnesia/doc/src/mnesia_frag_hash.xml b/lib/mnesia/doc/src/mnesia_frag_hash.xml index c233acdb05..ccaba412d0 100644 --- a/lib/mnesia/doc/src/mnesia_frag_hash.xml +++ b/lib/mnesia/doc/src/mnesia_frag_hash.xml @@ -34,7 +34,7 @@ A mnesia_frag_hash.sgml - mnesia_frag_hash + mnesia_frag_hash Defines mnesia_frag_hash callback behavior

This module defines a callback behavior for user-defined hash @@ -50,7 +50,7 @@ - init_state(Tab, State) -> NewState | abort(Reason) + init_state(Tab, State) -> NewState | abort(Reason) Initiates the hash state for a new table. Tab = atom() @@ -72,7 +72,7 @@ - add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + add_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a new fragment is added to a fragmented table. State = term() @@ -100,7 +100,7 @@ - del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) + del_frag(State) -> {NewState, IterFrags, AdditionalLockFrags} | abort(Reason) Starts when a fragment is deleted from a fragmented table. State = term() @@ -127,7 +127,7 @@ - key_to_frag_number(State, Key) -> FragNum | abort(Reason) + key_to_frag_number(State, Key) -> FragNum | abort(Reason) Resolves the key of a record into a fragment number. FragNum = integer() @@ -140,7 +140,7 @@ - match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) + match_spec_to_frag_numbers(State, MatchSpec) -> FragNums | abort(Reason) Resolves a MatchSpec into a list of fragment numbers. MatcSpec = ets_select_match_spec() diff --git a/lib/mnesia/doc/src/mnesia_registry.xml b/lib/mnesia/doc/src/mnesia_registry.xml index a76f716981..18ddc4ab9e 100644 --- a/lib/mnesia/doc/src/mnesia_registry.xml +++ b/lib/mnesia/doc/src/mnesia_registry.xml @@ -34,7 +34,7 @@ A mnesia_registry.sgml - mnesia_registry + mnesia_registry Dump support for registries in erl_interface.

This module is usually part of the erl_interface @@ -57,7 +57,7 @@ - create_table(Tab) -> ok | exit(Reason) + create_table(Tab) -> ok | exit(Reason) Creates a registry table in Mnesia.

A wrapper function for mnesia:create_table/2, @@ -73,7 +73,7 @@ - create_table(Tab, TabDef) -> ok | exit(Reason) + create_table(Tab, TabDef) -> ok | exit(Reason) Creates a customized registry table in Mnesia.

A wrapper function for mnesia:create_table/2, -- cgit v1.2.3 From 606ed183e31bb68c453495caae1c9fad787d48ea Mon Sep 17 00:00:00 2001 From: Sverker Eriksson Date: Wed, 12 Dec 2018 19:26:25 +0100 Subject: Fix since attribute for troubled function docs --- lib/mnesia/doc/src/mnesia.xml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'lib/mnesia') diff --git a/lib/mnesia/doc/src/mnesia.xml b/lib/mnesia/doc/src/mnesia.xml index 921721d4b7..94f1af34bf 100644 --- a/lib/mnesia/doc/src/mnesia.xml +++ b/lib/mnesia/doc/src/mnesia.xml @@ -2153,7 +2153,7 @@ mnesia:create_table(employee, - sync_transaction(Fun, [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} + sync_transaction(Fun, [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} Synchronously executes a transaction. @@ -2353,7 +2353,7 @@ mnesia:create_table(employee, - table(Tab [,[Option]]) -> QueryHandle + table(Tab [,[Option]]) -> QueryHandle Return a QLC query handle. @@ -2560,7 +2560,7 @@ mnesia:create_table(employee, - transaction(Fun [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} + transaction(Fun [[, Args], Retries]) -> {aborted, Reason} | {atomic, ResultOfFun} Executes a transaction. @@ -2658,7 +2658,7 @@ raise(Name, Amount) -> - traverse_backup(Source, [SourceMod,] Target, [TargetMod,] Fun, Acc) -> {ok, LastAcc} | {error, Reason} + traverse_backup(Source, [SourceMod,] Target, [TargetMod,] Fun, Acc) -> {ok, LastAcc} | {error, Reason} Traversal of a backup. -- cgit v1.2.3