FM / doc

/usr/share/vim/vim82/doc

Name	Size	Mode	Actions
arabic.txt	11901	0644	edit dl rm
autocmd.txt	72220	0644	edit dl rm
change.txt	78049	0644	edit dl rm
channel.txt	50309	0644	edit dl rm
cmdline.txt	49342	0644	edit dl rm
debug.txt	6896	0644	edit dl rm
debugger.txt	5443	0644	edit dl rm
develop.txt	22861	0644	edit dl rm
diff.txt	17024	0644	edit dl rm
digraph.txt	61978	0644	edit dl rm
editing.txt	74161	0644	edit dl rm
eval.txt	541209	0644	edit dl rm
farsi.txt	523	0644	edit dl rm
filetype.txt	27594	0644	edit dl rm
fold.txt	23689	0644	edit dl rm
ft_ada.txt	18246	0644	edit dl rm
ft_rust.txt	9596	0644	edit dl rm
ft_sql.txt	30700	0644	edit dl rm
gui.txt	52741	0644	edit dl rm
gui_w32.txt	19451	0644	edit dl rm
gui_x11.txt	29906	0644	edit dl rm
hangulin.txt	598	0644	edit dl rm
hebrew.txt	5666	0644	edit dl rm
help.txt	8899	0644	edit dl rm
helphelp.txt	15729	0644	edit dl rm
howto.txt	2916	0644	edit dl rm
if_cscop.txt	19325	0644	edit dl rm
if_lua.txt	16755	0644	edit dl rm
if_mzsch.txt	11941	0644	edit dl rm
if_ole.txt	7361	0644	edit dl rm
if_perl.txt	11281	0644	edit dl rm
if_pyth.txt	38435	0644	edit dl rm
if_ruby.txt	8516	0644	edit dl rm
if_sniff.txt	271	0644	edit dl rm
if_tcl.txt	22951	0644	edit dl rm
indent.txt	42284	0644	edit dl rm
index.txt	80638	0644	edit dl rm
insert.txt	85294	0644	edit dl rm
intro.txt	38972	0644	edit dl rm
map.txt	70799	0644	edit dl rm
mbyte.txt	59642	0644	edit dl rm
message.txt	31425	0644	edit dl rm
mlang.txt	8187	0644	edit dl rm
motion.txt	51341	0644	edit dl rm
netbeans.txt	37982	0644	edit dl rm
options.txt	391308	0644	edit dl rm
os_390.txt	4749	0644	edit dl rm
os_amiga.txt	5466	0644	edit dl rm
os_beos.txt	293	0644	edit dl rm
os_dos.txt	12378	0644	edit dl rm
os_haiku.txt	8592	0644	edit dl rm
os_mac.txt	6856	0644	edit dl rm
os_mint.txt	391	0644	edit dl rm
os_msdos.txt	523	0644	edit dl rm
os_os2.txt	299	0644	edit dl rm
os_qnx.txt	4071	0644	edit dl rm
os_risc.txt	328	0644	edit dl rm
os_unix.txt	2603	0644	edit dl rm
os_vms.txt	32906	0644	edit dl rm
os_win32.txt	13351	0644	edit dl rm
pattern.txt	60137	0644	edit dl rm
pi_getscript.txt	21082	0644	edit dl rm
pi_gzip.txt	1294	0644	edit dl rm
pi_logipat.txt	4196	0644	edit dl rm
pi_netrw.txt	179286	0644	edit dl rm
pi_paren.txt	2274	0644	edit dl rm
pi_spec.txt	4127	0644	edit dl rm
pi_tar.txt	6813	0644	edit dl rm
pi_vimball.txt	11859	0644	edit dl rm
pi_zip.txt	7294	0644	edit dl rm
popup.txt	39472	0644	edit dl rm
print.txt	31025	0644	edit dl rm
quickfix.txt	82925	0644	edit dl rm
quickref.txt	72144	0644	edit dl rm
quotes.txt	12748	0644	edit dl rm
recover.txt	10720	0644	edit dl rm
remote.txt	8417	0644	edit dl rm
repeat.txt	42186	0644	edit dl rm
rileft.txt	4938	0644	edit dl rm
russian.txt	3024	0644	edit dl rm
scroll.txt	13781	0644	edit dl rm
sign.txt	25859	0644	edit dl rm
spell.txt	64099	0644	edit dl rm
sponsor.txt	7203	0644	edit dl rm
starting.txt	73591	0644	edit dl rm
syntax.txt	225863	0644	edit dl rm
tabpage.txt	17248	0644	edit dl rm
tags	354812	0644	edit dl rm
tagsrch.txt	40278	0644	edit dl rm
term.txt	47498	0644	edit dl rm
terminal.txt	56100	0644	edit dl rm
testing.txt	14954	0644	edit dl rm
textprop.txt	13402	0644	edit dl rm
tips.txt	21067	0644	edit dl rm
todo.txt	309420	0644	edit dl rm
uganda.txt	14028	0644	edit dl rm
undo.txt	16584	0644	edit dl rm
usr_01.txt	7081	0644	edit dl rm
usr_02.txt	24226	0644	edit dl rm
usr_03.txt	23872	0644	edit dl rm
usr_04.txt	19131	0644	edit dl rm
usr_05.txt	27023	0644	edit dl rm
usr_06.txt	9611	0644	edit dl rm
usr_07.txt	15995	0644	edit dl rm
usr_08.txt	19378	0644	edit dl rm
usr_09.txt	11502	0644	edit dl rm
usr_10.txt	29200	0644	edit dl rm
usr_11.txt	13025	0644	edit dl rm
usr_12.txt	13429	0644	edit dl rm
usr_20.txt	13709	0644	edit dl rm
usr_21.txt	18456	0644	edit dl rm
usr_22.txt	14999	0644	edit dl rm
usr_23.txt	12744	0644	edit dl rm
usr_24.txt	20827	0644	edit dl rm
usr_25.txt	19176	0644	edit dl rm
usr_26.txt	8259	0644	edit dl rm
usr_27.txt	17709	0644	edit dl rm
usr_28.txt	16020	0644	edit dl rm
usr_29.txt	20121	0644	edit dl rm
usr_30.txt	22658	0644	edit dl rm
usr_31.txt	10399	0644	edit dl rm
usr_32.txt	5378	0644	edit dl rm
usr_40.txt	23195	0644	edit dl rm
usr_41.txt	97378	0644	edit dl rm
usr_42.txt	13853	0644	edit dl rm
usr_43.txt	7409	0644	edit dl rm
usr_44.txt	28948	0644	edit dl rm
usr_45.txt	17688	0644	edit dl rm
usr_46.txt	7096	0644	edit dl rm
usr_90.txt	16836	0644	edit dl rm
usr_toc.txt	9505	0644	edit dl rm
various.txt	31097	0644	edit dl rm
version4.txt	13911	0644	edit dl rm
version5.txt	308532	0644	edit dl rm
version6.txt	576940	0644	edit dl rm
version7.txt	674701	0644	edit dl rm
version8.txt	1940307	0644	edit dl rm
vim9.txt	57158	0644	edit dl rm
visual.txt	21794	0644	edit dl rm
vi_diff.txt	57428	0644	edit dl rm
windows.txt	55732	0644	edit dl rm
workshop.txt	371	0644	edit dl rm

Edit: /usr/share/vim/vim82/doc/testing.txt (14954B)

*testing.txt*	For Vim version 8.2.  Last change: 2021 Mar 10

VIM REFERENCE MANUAL	  by Bram Moolenaar

Testing Vim and Vim script			*testing-support*

Expression evaluation is explained in |eval.txt|.  This file goes into details
about writing tests in Vim script.  This can be used for testing Vim itself
and for testing plugins.

==============================================================================
1. Testing Vim						*testing*

Vim can be tested after building it, usually with "make test".
The tests are located in the directory "src/testdir".

There are two types of tests added over time:
	test20.in		oldest, only for tiny and small builds
	test_something.vim	new style tests

*new-style-testing*
New tests should be added as new style tests.  The test scripts are named
test_<feature>.vim (replace <feature> with the feature under test). These use
functions such as |assert_equal()| to keep the test commands and the expected
result in one place.
						*old-style-testing*
These tests are used only for testing Vim without the |+eval| feature.

Find more information in the file src/testdir/README.txt.

==============================================================================
2. Test functions				*test-functions-details*

test_alloc_fail({id}, {countdown}, {repeat})		*test_alloc_fail()*
		This is for testing: If the memory allocation with {id} is
		called, then decrement {countdown}, and when it reaches zero
		let memory allocation fail {repeat} times.  When {repeat} is
		smaller than one it fails one time.

Can also be used as a |method|: >
			GetAllocId()->test_alloc_fail()

test_autochdir()					*test_autochdir()*
		Set a flag to enable the effect of 'autochdir' before Vim
		startup has finished.

test_feedinput({string})				*test_feedinput()*
		Characters in {string} are queued for processing as if they
		were typed by the user. This uses a low level input buffer.
		This function works only when with |+unix| or GUI is running.

Can also be used as a |method|: >
			GetText()->test_feedinput()

test_garbagecollect_now()			 *test_garbagecollect_now()*
		Like garbagecollect(), but executed right away.  This must
		only be called directly to avoid any structure to exist
		internally, and |v:testing| must have been set before calling
		any function.

test_garbagecollect_soon()			 *test_garbagecollect_soon()*
		Set the flag to call the garbagecollector as if in the main
		loop.  Only to be used in tests.

test_getvalue({name})					*test_getvalue()*
		Get the value of an internal variable.  These values for
		{name} are supported:
			need_fileinfo

Can also be used as a |method|: >
			GetName()->test_getvalue()

test_ignore_error({expr})			 *test_ignore_error()*
		Ignore any error containing {expr}.  A normal message is given
		instead.
		This is only meant to be used in tests, where catching the
		error with try/catch cannot be used (because it skips over
		following code).
		{expr} is used literally, not as a pattern.
		When the {expr} is the string "RESET" then the list of ignored
		errors is made empty.

Can also be used as a |method|: >
			GetErrorText()->test_ignore_error()

test_null_blob()					*test_null_blob()*
		Return a |Blob| that is null. Only useful for testing.

test_null_channel()					*test_null_channel()*
		Return a |Channel| that is null. Only useful for testing.
		{only available when compiled with the +channel feature}

test_null_dict()					*test_null_dict()*
		Return a |Dict| that is null. Only useful for testing.

test_null_function()					*test_null_function()*
		Return a |Funcref| that is null. Only useful for testing.

test_null_job()						*test_null_job()*
		Return a |Job| that is null. Only useful for testing.
		{only available when compiled with the +job feature}

test_null_list()					*test_null_list()*
		Return a |List| that is null. Only useful for testing.

test_null_partial()					*test_null_partial()*
		Return a |Partial| that is null. Only useful for testing.

test_null_string()					*test_null_string()*
		Return a |String| that is null. Only useful for testing.

test_unknown()						*test_unknown()*
		Return a value with unknown type. Only useful for testing.

test_void()						*test_void()*
		Return a value with void type. Only useful for testing.

test_option_not_set({name})				*test_option_not_set()*
		Reset the flag that indicates option {name} was set.  Thus it
		looks like it still has the default value. Use like this: >
			set ambiwidth=double
			call test_option_not_set('ambiwidth')
<		Now the 'ambiwidth' option behaves like it was never changed,
		even though the value is "double".
		Only to be used for testing!

Can also be used as a |method|: >
			GetOptionName()->test_option_not_set()

test_override({name}, {val})				*test_override()*
		Overrides certain parts of Vim's internal processing to be able
		to run tests. Only to be used for testing Vim!
		The override is enabled when {val} is non-zero and removed
		when {val} is zero.
		Current supported values for name are:

name	     effect when {val} is non-zero ~
		redraw       disable the redrawing() function
		redraw_flag  ignore the RedrawingDisabled flag
		char_avail   disable the char_avail() function
		starting     reset the "starting" variable, see below
		nfa_fail     makes the NFA regexp engine fail to force a
			     fallback to the old engine
		no_query_mouse  do not query the mouse position for "dec"
				terminals
		no_wait_return	set the "no_wait_return" flag.  Not restored
				with "ALL".
		ui_delay     time in msec to use in ui_delay(); overrules a
			     wait time of up to 3 seconds for messages
		term_props   reset all terminal properties when the version
			     string is detected
		uptime 	     overrules sysinfo.uptime
		ALL	     clear all overrides ({val} is not used)

"starting" is to be used when a test should behave like
		startup was done.  Since the tests are run by sourcing a
		script the "starting" variable is non-zero. This is usually a
		good thing (tests run faster), but sometimes changes behavior
		in a way that the test doesn't work properly.
		When using: >
			call test_override('starting', 1)
<		The value of "starting" is saved.  It is restored by: >
			call test_override('starting', 0)

<		Can also be used as a |method|: >
			GetOverrideVal()-> test_override('starting')

test_refcount({expr})					*test_refcount()*
		Return the reference count of {expr}.  When {expr} is of a
		type that does not have a reference count, returns -1.  Only
		to be used for testing.

Can also be used as a |method|: >
			GetVarname()->test_refcount()

test_scrollbar({which}, {value}, {dragging})		*test_scrollbar()*
		Pretend using scrollbar {which} to move it to position
		{value}.  {which} can be:
			left	Left scrollbar of the current window
			right	Right scrollbar of the current window
			hor	Horizontal scrollbar

For the vertical scrollbars {value} can be 1 to the
		line-count of the buffer.  For the horizontal scrollbar the
		{value} can be between 1 and the maximum line length, assuming
		'wrap' is not set.

When {dragging} is non-zero it's like dragging the scrollbar,
		otherwise it's like clicking in the scrollbar.
		Only works when the {which} scrollbar actually exists,
		obviously only when using the GUI.

Can also be used as a |method|: >
			GetValue()->test_scrollbar('right', 0)

test_setmouse({row}, {col})				*test_setmouse()*
		Set the mouse position to be used for the next mouse action.
		{row} and {col} are one based.
		For example: >
			call test_setmouse(4, 20)
			call feedkeys("\<LeftMouse>", "xt")

test_settime({expr})					*test_settime()*
		Set the time Vim uses internally.  Currently only used for
		timestamps in the history, as they are used in viminfo, and
		for undo.
		Using a value of 1 makes Vim not sleep after a warning or
		error message.
		{expr} must evaluate to a number.  When the value is zero the
		normal behavior is restored.

Can also be used as a |method|: >
			GetTime()->test_settime()

test_srand_seed([seed])					*test_srand_seed()*
		When [seed] is given this sets the seed value used by
		`srand()`.  When omitted the test seed is removed.

==============================================================================
3. Assert functions				*assert-functions-details*

assert_beeps({cmd})					*assert_beeps()*
		Run {cmd} and add an error message to |v:errors| if it does
		NOT produce a beep or visual bell.
		Also see |assert_fails()| and |assert-return|.

Can also be used as a |method|: >
			GetCmd()->assert_beeps()
<
							*assert_equal()*
assert_equal({expected}, {actual} [, {msg}])
		When {expected} and {actual} are not equal an error message is
		added to |v:errors| and 1 is returned.  Otherwise zero is
		returned |assert-return|.
		There is no automatic conversion, the String "4" is different
		from the Number 4.  And the number 4 is different from the
		Float 4.0.  The value of 'ignorecase' is not used here, case
		always matters.
		When {msg} is omitted an error in the form "Expected
		{expected} but got {actual}" is produced.
		Example: >
	assert_equal('foo', 'bar')
<		Will result in a string to be added to |v:errors|:
	test.vim line 12: Expected 'foo' but got 'bar' ~

Can also be used as a |method|, the base is passed as the
		second argument: >
			mylist->assert_equal([1, 2, 3])

<							*assert_equalfile()*
assert_equalfile({fname-one}, {fname-two} [, {msg}])
		When the files {fname-one} and {fname-two} do not contain
		exactly the same text an error message is added to |v:errors|.
		Also see |assert-return|.
		When {fname-one} or {fname-two} does not exist the error will
		mention that.
		Mainly useful with |terminal-diff|.

Can also be used as a |method|: >
			GetLog()->assert_equalfile('expected.log')

assert_exception({error} [, {msg}])			*assert_exception()*
		When v:exception does not contain the string {error} an error
		message is added to |v:errors|.  Also see |assert-return|.
		This can be used to assert that a command throws an exception.
		Using the error number, followed by a colon, avoids problems
		with translations: >
			try
			  commandthatfails
			  call assert_false(1, 'command should have failed')
			catch
			  call assert_exception('E492:')
			endtry
<
							*assert_fails()*
assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
		Run {cmd} and add an error message to |v:errors| if it does
		NOT produce an error or when {error} is not found in the
		error message.  Also see |assert-return|.

When {error} is a string it must be found literally in the
		first reported error. Most often this will be the error code,
		including the colon, e.g. "E123:". >
			assert_fails('bad cmd', 'E987:')
<
		When {error} is a |List| with one or two strings, these are
		used as patterns.  The first pattern is matched against the
		first reported error: >
			assert_fails('cmd', ['E987:.*expected bool'])
<		The second pattern, if present, is matched against the last
		reported error.
		If there is only one error then both patterns must match. This
		can be used to check that there is only one error.
		To only match the last error use an empty string for the first
		error: >
			assert_fails('cmd', ['', 'E987:'])
<
		If {msg} is empty then it is not used.  Do this to get the
		default message when passing the {lnum} argument.

When {lnum} is present and not negative, and the {error}
		argument is present and matches, then this is compared with
		the line number at which the error was reported. That can be
		the line number in a function or in a script.

When {context} is present it is used as a pattern and matched
		against the context (script name or function name) where
		{lnum} is located in.

Note that beeping is not considered an error, and some failing
		commands only beep.  Use |assert_beeps()| for those.

Can also be used as a |method|: >
			GetCmd()->assert_fails('E99:')

assert_false({actual} [, {msg}])			*assert_false()*
		When {actual} is not false an error message is added to
		|v:errors|, like with |assert_equal()|.
		Also see |assert-return|.
		A value is false when it is zero. When {actual} is not a
		number the assert fails.
		When {msg} is omitted an error in the form
		"Expected False but got {actual}" is produced.

Can also be used as a |method|: >
			GetResult()->assert_false()

assert_inrange({lower}, {upper}, {actual} [, {msg}])	 *assert_inrange()*
		This asserts number and |Float| values.  When {actual}  is lower
		than {lower} or higher than {upper} an error message is added
		to |v:errors|.  Also see |assert-return|.
		When {msg} is omitted an error in the form
		"Expected range {lower} - {upper}, but got {actual}" is
		produced.

*assert_match()*
assert_match({pattern}, {actual} [, {msg}])
		When {pattern} does not match {actual} an error message is
		added to |v:errors|.  Also see |assert-return|.

{pattern} is used as with |=~|: The matching is always done
		like 'magic' was set and 'cpoptions' is empty, no matter what
		the actual value of 'magic' or 'cpoptions' is.

{actual} is used as a string, automatic conversion applies.
		Use "^" and "$" to match with the start and end of the text.
		Use both to match the whole text.

When {msg} is omitted an error in the form
		"Pattern {pattern} does not match {actual}" is produced.
		Example: >
	assert_match('^f.*o$', 'foobar')
<		Will result in a string to be added to |v:errors|:
	test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~

Can also be used as a |method|: >
			getFile()->assert_match('foo.*')
<
							*assert_notequal()*
assert_notequal({expected}, {actual} [, {msg}])
		The opposite of `assert_equal()`: add an error message to
		|v:errors| when {expected} and {actual} are equal.
		Also see |assert-return|.

Can also be used as a |method|: >
			mylist->assert_notequal([1, 2, 3])

<							*assert_notmatch()*
assert_notmatch({pattern}, {actual} [, {msg}])
		The opposite of `assert_match()`: add an error message to
		|v:errors| when {pattern} matches {actual}.
		Also see |assert-return|.

Can also be used as a |method|: >
			getFile()->assert_notmatch('bar.*')

assert_report({msg})					*assert_report()*
		Report a test failure directly, using {msg}.
		Always returns one.

Can also be used as a |method|: >
			GetMessage()->assert_report()

assert_true({actual} [, {msg}])				*assert_true()*
		When {actual} is not true an error message is added to
		|v:errors|, like with |assert_equal()|.
		Also see |assert-return|.
		A value is TRUE when it is a non-zero number.  When {actual}
		is not a number the assert fails.
		When {msg} is omitted an error in the form "Expected True but
		got {actual}" is produced.

Can also be used as a |method|: >
			GetResult()->assert_true()
<

vim:tw=78:ts=8:noet:ft=help:norl:

cmd: