aboutsummaryrefslogtreecommitdiffstats
path: root/system/doc/reference_manual
AgeCommit message (Collapse)Author
2018-08-09Fix violation of documentation rulesBjörn Gustavsson
In the documentation, we don't use contractations such as "don't" or "that's". We also avoid abbreviations. "i.e." should be written out as "that is". In this case it is better to omit it altogether. 629ad2e0971ef introduced the violation.
2018-08-08Add clarification on nil typeBrujo Benavides
As explained by @psyeugenic on Slack: > empty list `[]` is regarded as a separate type from `list()`, `[]` < `list()` > i.e. nil is `[]`
2018-07-13docs: make clean all XMLDIRLukas Larsson
2018-06-18Update copyright yearHenrik Nord
2018-05-24Merge branch 'siri/logger-fix'Siri Hansen
* siri/logger-fix: Update documentation of logger and error_logger Change type name logger:log() to logger:log_event() Update preloaded Update primary bootstrap Rename module logger_simple to logger_simple_h Change env var logger_log_progress to logger_progress_reports Remove HandlerId from handler callback functions and add it to Config Change handler id for sasl handler from sasl_h to sasl Change Compare parameter to logger_filters:domain/2 Update Logger documentation Rename reset_module_level to unset_module_level Allow chars_limit to limit strings Add logger:update_formatter_config/2,3 Set legacy_header=true for kernel's default handler only Improve documentation of logger and error_logger Use system_time instead of monotonic_time as timestamp in logger
2018-05-24Update copyright yearHenrik Nord
2018-05-23Improve documentation of logger and error_loggerSiri Hansen
2018-05-09macros.xml: Document ?OTP_RELEASE, -if and -elifTomas Abrahamsson
2018-04-09erl_docgen: Add ghlink step for all non-generated doc xml filesLukas Larsson
In order to get line numbers into the ghlink we have to add a post processing step for all xml files.
2018-03-21Add an option to ?MODULE:module_info/1 for listing NIFsJohn Högberg
2017-11-30Add documentation for the new stacktrace syntaxBjörn Gustavsson
2017-10-31Refactor xmllint check and make it fail on failureLukas Larsson
This commit also adds a check to see that all files that are part of an xi:include also have part of XML_FILES and vice versa. It also fixes any applications where this was not true.
2017-09-12Dialyzer: Rewrite some of the docs of map typesHans Bolinder
Use "association" instead of "pair" as in Data Types and The Abstract Format.
2017-06-14Update copyright yearHans Nilsson
2017-05-23otp: Extend secure distribution docs warningsLukas Larsson
Warnings have been added to the relevant documentation about not using un-secure distributed nodes in exposed environments.
2017-05-05Merge pull request #1437 from c0b/fix-typo/reference-manualHans Bolinder
system/doc/reference_manual/: fix a typo
2017-05-04Update copyright yearRaimo Niskanen
2017-05-02system/doc/reference_manual/: fix a typomr c0b
2017-04-27Merge branch 'ingela/deprecate/gen_fsm/OTP-14183'Ingela Anderton Andin
* ingela/deprecate/gen_fsm/OTP-14183: stdlib: Deprecate gen_fsm Conflicts: lib/stdlib/doc/src/gen_fsm.xml
2017-04-27stdlib: Deprecate gen_fsmIngela Anderton Andin
2017-04-25Document that app names and nodes names are restricted to latin-1Siri Hansen
2017-03-17Update the documentation regarding Unicode atomsBjörn Gustavsson
2017-02-20Documentation: fix link to erlang(3) man pageStephan Renatus
I don't see why this should point to process_flag/2. Let's make it not do that.
2017-01-11character_set.xml: Remove a superfluous reference to OTP R5Björn Gustavsson
2017-01-11records.xml: Remove a superfluous reference to OTP R8Björn Gustavsson
2017-01-11macros.xml: Remove a reference to OTP R7Björn Gustavsson
2017-01-11expressions.xml: Remove superfluous references to OTP R7/R10Björn Gustavsson
2017-01-11errors.xml: Remove superfluous references to R10BBjörn Gustavsson
2017-01-11data_types.xml: Remove superfluous reference to R9BBjörn Gustavsson
2017-01-11Say that features after R13A are mentioned in the textBjörn Gustavsson
The text mentions any changes that occurred in R7A and later. Change that to only mention changes that occurred after R12B.
2016-12-12doc: Enchance map pair optional/mandatory notesBjörn-Egil Dahlberg
2016-12-12doc: Change "stands for" to "denotes" in typespecBjörn-Egil Dahlberg
2016-12-12Remove whitespace errorsBjörn-Egil Dahlberg
2016-12-07Update copyright-yearErlang/OTP
2016-10-05Update per review comments.Doug Rohrer
2016-10-04Fix reference to automatic `undefined` field declared types.Doug Rohrer
In 8ce35b287fb50a6845fccf6a13c672aae303dc91 automatic insertion of `undefined` for record fields without initializers was removed, but this was not noted in the documentation. Add a warning about this change using similar verbiage as the original docs.
2016-09-01doc: Correct errors introduced by Editorial changesHans Bolinder
Fix some older errors as well.
2016-07-12Add clarification on LC semantics (#1)Brujo Benavides
It addresses the special case of generator-less LCs. As a bonus, I fixed a typo :)
2016-06-09Remove support for '...' in Maps typesHans Bolinder
It is possible that '...' is added later (OTP 20.0), but for now we are not sure of all details.
2016-05-09Merge branch 'bjorn/stdlib/warning-and-error/OTP-13476'Björn Gustavsson
* bjorn/stdlib/warning-and-error/OTP-13476: Add documentation epp: Add the -error and -warning directives epp: Refactor expansion of header path
2016-05-04Update documentation regarding improvementsBjörn Gustavsson
2016-05-04Add documentationBjörn Gustavsson
2016-04-28doc: Correct shorthand typoBjörn-Egil Dahlberg
2016-04-28erl_parse: Add parsing for new map type syntaxMagnus Lång
erl_types typesets mandatory keys with :=, and uses "..." as a shorthand for "any() => any()". Add these to erl_parse so that all representable types can be written in type-specs.
2016-04-25Merge branch 'raimo/new-gen-state-machine/OTP-13065'Raimo Niskanen
* raimo/new-gen-state-machine/OTP-13065: (52 commits) Add section on state filtering Promote gen_statem over gen_fsm Modify code_change/4 to return CallbackMode Use ?NAME macro in examples Introduce Fred Herbert suggested additions Introduce corrections from Fred Hebert and Ingela Use .png pictures instead of .gif Write Design Principles chapter Fix missing short forms for event timeout Do more intricate Fred Hebert doc changes Change Caller -> From as suggested by Fred Hebert Do documentation improvements from Fred Hebert Fix broken documenation reference Rename state_timeout -> event_timeout Fix most of the system docs and emacs mode Change code_change/4 to {ok,State,Data} Fixup sharpened test suite Sharpen test suite Remove the remove_event action and all alike Relax caller() type check and cleanup ... Conflicts: lib/stdlib/src/gen.erl lib/stdlib/src/gen_event.erl lib/stdlib/src/gen_fsm.erl lib/stdlib/src/gen_server.erl lib/stdlib/test/error_logger_forwarder.erl
2016-03-15update copyright-yearHenrik Nord
2016-03-04erts: Use 'bit string' in The Abstract Format documentHans Bolinder
2016-03-03Fix most of the system docs and emacs modeRaimo Niskanen
2016-03-01Generalize bit string comprehensionsBjörn Gustavsson
The expression in a bit string comprehension is limited to a literal bit string expression. That is, the following code is legal: << <<X>> || X <- List >> but not this code: << foo(X) || X <- List >> The limitation is annoying. For one thing, tools that transform the abstract format must be careful not to produce code such as: << begin %% Some instrumentation code. <<X>> end || X <- List >> One reason for the limitation could be that we'll get reduce/reduce conflicts if we try to allow an arbitrary expression in a bit string comprehension: binary_comprehension -> '<<' expr '||' lc_exprs '>>' : {bc,?anno('$1'),'$2','$4'}. Unfortunately, there does not seem to be an easy way to work around that problem. The best we can do is to allow 'expr_max' expressions (as in the binary syntax): binary_comprehension -> '<<' expr_max '||' lc_exprs '>>' : {bc,?anno('$1'),'$2','$4'}. That will work, but functions calls must be enclosed in parentheses: << (foo(X)) || X <- List >>
2016-02-17Implement ?FUNCTION_NAME and ?FUNCTION_ARITY macrosBjörn Gustavsson
For a long time, users have asked for one or more macros that would return the name and arity of the current function. We could define a single ?FUNCTION macro that would return a {Name,Arity} tuple. However, to access just the name or just the arity for the function, element/2 must be used. That would limit its usefulness, because element/2 is not allowed in all contexts. Therefore, it seems that we will need two macros. ?FUNCTION_NAME that expands to the name of the current function and ?FUNCTION_ARITY that expands to arity of the current function. Converting the function name to a string can be done like this: f() -> atom_to_list(?FUNCTION_NAME) ++ "/" ++ integer_to_list(?FUNCTION_ARITY). f/0 will return "f/0". The BEAM compiler will evaluate the entire expression at compile-time, so there will not be any run-time penalty for the function calls. The implementation is non-trivial because the preprocessor is run before the parser. One way to implement the macros would be to replace them with some placeholder and then let the parser or possibly a later pass replace the placeholder with correct value. That could potentially slow down the compiler and cause incompatibilities for parse transforms. Another way is to let the preprocessor do the whole job. That means that the preprocessor will have to scan the function head to find out the name and arity. The scanning of the function head can be delayed until the first occurrence of a ?FUNCTION_NAME or ?FUNCTION_ARITY. I have chosen the second way because it seems less likely to cause weird compatibility problems.