From dfd4b66c48106edfcbdd1b32e733640e2587acbb Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Thu, 3 Dec 2009 12:21:55 +0000 Subject: documentation: Fix bugs introduced in the SGML to XML transition In the transition from SGML to XML (several releases ago), bugs were introduced in the documentation, for instance "\n" replaced by newlines. Correct those bugs. Also correct double backslashes. They seem to have been introduced very early in the development of OTP. According to Lars they "solved" a bug in the generation of HTML &c. Now that standard tools are used instead of docbuilder, the bug has become visible. --- system/doc/embedded/embedded_solaris.xml | 8 ++--- system/doc/embedded/starting.xml | 2 +- system/doc/reference_manual/data_types.xml | 36 ++++++++++----------- system/doc/system_principles/create_target.xml | 45 ++++++++++++-------------- 4 files changed, 43 insertions(+), 48 deletions(-) (limited to 'system') diff --git a/system/doc/embedded/embedded_solaris.xml b/system/doc/embedded/embedded_solaris.xml index 93532da8e6..d1fb2ddc5f 100644 --- a/system/doc/embedded/embedded_solaris.xml +++ b/system/doc/embedded/embedded_solaris.xml @@ -580,7 +580,7 @@ fi START_ERL_DATA=${1:-$RELDIR/start_erl.data} -$ROOTDIR/bin/run_erl /tmp/ $ROOTDIR/log "exec $ROOTDIR/bin/start_erl \\ +$ROOTDIR/bin/run_erl /tmp/ $ROOTDIR/log "exec $ROOTDIR/bin/start_erl \ $ROOTDIR $RELDIR $START_ERL_DATA" > /dev/null 2>&1 &]]>

The following script illustrates a modification where the node is given the name cp1, and the environment variables @@ -604,7 +604,7 @@ fi START_ERL_DATA=${1:-$RELDIR/start_erl.data} -$ROOTDIR/bin/run_erl /tmp/ $ROOTDIR/log "exec $ROOTDIR/bin/start_erl \\ +$ROOTDIR/bin/run_erl /tmp/ $ROOTDIR/log "exec $ROOTDIR/bin/start_erl \ $ROOTDIR $RELDIR $START_ERL_DATA -heart -sname cp1" > /dev/null 2>&1 &]]>

If a diskless and/or read-only client node is about to start the start_erl.data file is located in the client directory at @@ -702,7 +702,7 @@ VSN=`awk '{print $2}' $DataFile` BINDIR=$ROOTDIR/erts-$ERTS_VSN/bin EMU=beam -PROGNAME=`echo $0 | sed 's/.*\\///'` +PROGNAME=`echo $0 | sed 's/.*\///'` export EMU export ROOTDIR export BINDIR @@ -726,7 +726,7 @@ exec $BINDIR/erlexec -boot $RELDIR/$VSN/start -config $RELDIR/$VSN/sys $* should look like:

-exec $BINDIR/erlexec -boot $CLIENTDIR/bin/start \\ +exec $BINDIR/erlexec -boot $CLIENTDIR/bin/start \ -config $CLIENTDIR/bin/sys $* diff --git a/system/doc/embedded/starting.xml b/system/doc/embedded/starting.xml index ddeaeb8bdf..228d91f430 100644 --- a/system/doc/embedded/starting.xml +++ b/system/doc/embedded/starting.xml @@ -219,7 +219,7 @@ VSN=`awk '{print $2}' $DataFile` BINDIR=$ROOTDIR/erts-$ERTS_VSN/bin EMU=beam -PROGNAME=`echo $0 | sed 's/.*\\///'` +PROGNAME=`echo $0 | sed 's/.*\///'` export EMU export ROOTDIR export BINDIR diff --git a/system/doc/reference_manual/data_types.xml b/system/doc/reference_manual/data_types.xml index c85ac44165..df1c0f8fa8 100644 --- a/system/doc/reference_manual/data_types.xml +++ b/system/doc/reference_manual/data_types.xml @@ -59,7 +59,7 @@ 42 2> $A. 65 -3> $\ . +3> $\n. 10 4> 2#101. 5 @@ -296,68 +296,68 @@ true Description - \\b + \b backspace - \\d + \d delete - \\e + \e escape - \\f + \f form feed - \ + \n newline - \\r + \r carriage return - \\s + \s space - \\t + \t tab - \\v + \v vertical tab - \\XYZ, \\YZ, \\Z + \XYZ, \YZ, \Z character with octal representation XYZ, YZ or Z - \\xXY + \xXY character with hexadecimal representation XY - \\x{X...} + \x{X...} character with hexadecimal representation; X... is one or more hexadecimal characters - \\^a...\\^z

-\\^A...\\^Z + \^a...\^z

+\^A...\^Z control A to control Z - \\' + \' single quote - \\" + \" double quote - \\\\ + \\ backslash Recognized Escape Sequences. diff --git a/system/doc/system_principles/create_target.xml b/system/doc/system_principles/create_target.xml index 9899b6e266..7d9f4681b9 100644 --- a/system/doc/system_principles/create_target.xml +++ b/system/doc/system_principles/create_target.xml @@ -259,9 +259,9 @@ os> /usr/local/erl-target/bin/erl -boot /usr/local/erl-target/releases/FI %% create(RelFileName) -> RelFile = RelFileName ++ ".rel", - io:fwrite("Reading file: \\"~s\\" ...~n", [RelFile]), + io:fwrite("Reading file: \"~s\" ...~n", [RelFile]), {ok, [RelSpec]} = file:consult(RelFile), - io:fwrite("Creating file: \\"~s\\" from \\"~s\\" ...~n", + io:fwrite("Creating file: \"~s\" from \"~s\" ...~n", ["plain.rel", RelFile]), {release, {RelName, RelVsn}, @@ -282,40 +282,39 @@ create(RelFileName) -> io:fwrite(Fd, "~p.~n", [PlainRelSpec]), file:close(Fd), - io:fwrite("Making \\"plain.script\\" and \\"plain.boot\\" files ...~n"), + io:fwrite("Making \"plain.script\" and \"plain.boot\" files ...~n"), make_script("plain"), - io:fwrite("Making \\"~s.script\\" and \\"~s.boot\\" files ...~n", + io:fwrite("Making \"~s.script\" and \"~s.boot\" files ...~n", [RelFileName, RelFileName]), make_script(RelFileName), TarFileName = io_lib:fwrite("~s.tar.gz", [RelFileName]), - io:fwrite("Creating tar file \\"~s\\" ...~n", [TarFileName]), + io:fwrite("Creating tar file \"~s\" ...~n", [TarFileName]), make_tar(RelFileName), - io:fwrite("Creating directory \\"tmp\\" ...~n"), + io:fwrite("Creating directory \"tmp\" ...~n"), file:make_dir("tmp"), - io:fwrite("Extracting \\"~s\\" into directory \\"tmp\\" ...~n", [TarFileName]), + io:fwrite("Extracting \"~s\" into directory \"tmp\" ...~n", [TarFileName]), extract_tar(TarFileName, "tmp"), TmpBinDir = filename:join(["tmp", "bin"]), ErtsBinDir = filename:join(["tmp", "erts-" ++ ErtsVsn, "bin"]), - io:fwrite("Deleting \\"erl\\" and \\"start\\" in directory \\"~s\\" ...~n", + io:fwrite("Deleting \"erl\" and \"start\" in directory \"~s\" ...~n", [ErtsBinDir]), file:delete(filename:join([ErtsBinDir, "erl"])), file:delete(filename:join([ErtsBinDir, "start"])), - io:fwrite("Creating temporary directory \\"~s\\" ...~n", [TmpBinDir]), + io:fwrite("Creating temporary directory \"~s\" ...~n", [TmpBinDir]), file:make_dir(TmpBinDir), - io:fwrite("Copying file \\"plain.boot\\" to \\"~s\\" ...~n", + io:fwrite("Copying file \"plain.boot\" to \"~s\" ...~n", [filename:join([TmpBinDir, "start.boot"])]), copy_file("plain.boot", filename:join([TmpBinDir, "start.boot"])), - io:fwrite("Copying files \\"epmd\\", \\"run_erl\\" and \\"to_erl\\" from \ -" - "\\"~s\\" to \\"~s\\" ...~n", + io:fwrite("Copying files \"epmd\", \"run_erl\" and \"to_erl\" from \n" + "\"~s\" to \"~s\" ...~n", [ErtsBinDir, TmpBinDir]), copy_file(filename:join([ErtsBinDir, "epmd"]), filename:join([TmpBinDir, "epmd"]), [preserve]), @@ -325,12 +324,12 @@ create(RelFileName) -> filename:join([TmpBinDir, "to_erl"]), [preserve]), StartErlDataFile = filename:join(["tmp", "releases", "start_erl.data"]), - io:fwrite("Creating \\"~s\\" ...~n", [StartErlDataFile]), + io:fwrite("Creating \"~s\" ...~n", [StartErlDataFile]), StartErlData = io_lib:fwrite("~s ~s~n", [ErtsVsn, RelVsn]), write_file(StartErlDataFile, StartErlData), - io:fwrite("Recreating tar file \\"~s\\" from contents in directory " - "\\"tmp\\" ...~n", [TarFileName]), + io:fwrite("Recreating tar file \"~s\" from contents in directory " + "\"tmp\" ...~n", [TarFileName]), {ok, Tar} = erl_tar:open(TarFileName, [write, compressed]), {ok, Cwd} = file:get_cwd(), file:set_cwd("tmp"), @@ -340,7 +339,7 @@ create(RelFileName) -> erl_tar:add(Tar, "lib", []), erl_tar:close(Tar), file:set_cwd(Cwd), - io:fwrite("Removing directory \\"tmp\\" ...~n"), + io:fwrite("Removing directory \"tmp\" ...~n"), remove_dir_tree("tmp"), ok. @@ -351,19 +350,15 @@ install(RelFileName, RootDir) -> extract_tar(TarFile, RootDir), StartErlDataFile = filename:join([RootDir, "releases", "start_erl.data"]), {ok, StartErlData} = read_txt_file(StartErlDataFile), - [ErlVsn, RelVsn| _] = string:tokens(StartErlData, " \ -"), + [ErlVsn, RelVsn| _] = string:tokens(StartErlData, " \n"), ErtsBinDir = filename:join([RootDir, "erts-" ++ ErlVsn, "bin"]), BinDir = filename:join([RootDir, "bin"]), - io:fwrite("Substituting in erl.src, start.src and start_erl.src to\ -" - "form erl, start and start_erl ...\ -"), + io:fwrite("Substituting in erl.src, start.src and start_erl.src to\n" + "form erl, start and start_erl ...\n"), subst_src_scripts(["erl", "start", "start_erl"], ErtsBinDir, BinDir, [{"FINAL_ROOTDIR", RootDir}, {"EMU", "beam"}], [preserve]), - io:fwrite("Creating the RELEASES file ...\ -"), + io:fwrite("Creating the RELEASES file ...\n"), create_RELEASES(RootDir, filename:join([RootDir, "releases", RelFileName])). -- cgit v1.2.3